OpenOCD
target.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
3 /***************************************************************************
4  * Copyright (C) 2005 by Dominic Rath *
5  * Dominic.Rath@gmx.de *
6  * *
7  * Copyright (C) 2007-2010 Øyvind Harboe *
8  * oyvind.harboe@zylin.com *
9  * *
10  * Copyright (C) 2008 by Spencer Oliver *
11  * spen@spen-soft.co.uk *
12  * *
13  * Copyright (C) 2011 by Broadcom Corporation *
14  * Evan Hunter - ehunter@broadcom.com *
15  * *
16  * Copyright (C) ST-Ericsson SA 2011 *
17  * michel.jaouen@stericsson.com : smp minimum support *
18  ***************************************************************************/
19 
20 #ifndef OPENOCD_TARGET_TARGET_H
21 #define OPENOCD_TARGET_TARGET_H
22 
23 #include <helper/list.h>
24 #include "helper/replacements.h"
25 #include "helper/system.h"
26 #include <helper/types.h>
27 #include <jim.h>
28 
29 struct reg;
30 struct trace;
31 struct command_context;
32 struct command_invocation;
33 struct breakpoint;
34 struct watchpoint;
35 struct mem_param;
36 struct reg_param;
37 struct target_list;
38 struct gdb_fileio_info;
39 
40 /*
41  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
42  * TARGET_RUNNING = 1: the target is executing or ready to execute 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)
49  *
50  * also see: target_state_name();
51  */
52 
59 };
60 
63  RESET_RUN = 1, /* reset and let target run */
64  RESET_HALT = 2, /* reset and halt target out of reset */
65  RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
66 };
67 
78 };
79 
83 };
84 
85 struct working_area {
87  uint32_t size;
88  bool free;
89  uint8_t *backup;
90  struct working_area **user;
91  struct working_area *next;
92 };
93 
94 struct gdb_service {
95  struct target *target;
96  /* field for smp display */
97  /* element 0 coreid currently displayed ( 1 till n) */
98  /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
99  * all cores core displayed */
100  int32_t core[2];
101 };
102 
103 /* target back off timer */
105  int times;
106  int count;
107 };
108 
109 /* split target registers into multiple class */
113 };
114 
115 /* target_type.h contains the full definition of struct target_type */
116 struct target {
117  struct target_type *type; /* target type definition (name, access functions) */
118  char *cmd_name; /* tcl Name of target */
119  struct jtag_tap *tap; /* where on the jtag chain is this */
120  int32_t coreid; /* which device on the TAP? */
121 
124 
131  bool examined;
132 
141 
142  struct list_head events_action;
143 
144  bool reset_halt; /* attempt resetting the CPU into the halted mode? */
145  target_addr_t working_area; /* working area (initialised RAM). Evaluated
146  * upon first allocation from virtual/physical address. */
147  bool working_area_virt_spec; /* virtual address specified? */
148  target_addr_t working_area_virt; /* virtual address */
149  bool working_area_phys_spec; /* physical address specified? */
150  target_addr_t working_area_phys; /* physical address */
151  uint32_t working_area_size; /* size in bytes */
152  bool backup_working_area; /* whether the content of the working area has to be preserved */
153  struct working_area *working_areas;/* list of allocated working areas */
154  enum target_debug_reason debug_reason;/* reason why the target entered debug state */
155  enum target_endianness endianness; /* target endianness */
156  /* also see: target_state_name() */
157  enum target_state state; /* the current backend-state (running, halted, ...) */
158  struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
159  struct breakpoint *breakpoints; /* list of breakpoints */
160  struct watchpoint *watchpoints; /* list of watchpoints */
161  struct trace *trace_info; /* generic trace information */
162  struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
163  bool dbg_msg_enabled; /* debug message status */
164  void *arch_info; /* architecture specific information */
165  void *private_config; /* pointer to target specific config data (for jim_configure hook) */
166  struct target *next; /* next target in list */
167 
168  bool verbose_halt_msg; /* display async info in telnet session. Do not display
169  * lots of halted/resumed info when stepping in debugger. */
170  bool halt_issued; /* did we transition to halted state? */
171  int64_t halt_issued_time; /* Note time when halt was issued */
172 
173  /* ARM v7/v8 targets with ADIv5 interface */
174  bool dbgbase_set; /* By default the debug base is not set */
175  uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
176  * system in place to support target specific options
177  * currently. */
178  bool has_dap; /* set to true if target has ADIv5 support */
179  bool dap_configured; /* set to true if ADIv5 DAP is configured */
180  bool tap_configured; /* set to true if JTAG tap has been configured
181  * through -chain-position */
182 
183  struct rtos *rtos; /* Instance of Real Time Operating System support */
184  bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
185  * and must be detected when symbols are offered */
186  struct backoff_timer backoff;
187  unsigned int smp; /* Unique non-zero number for each SMP group */
188  struct list_head *smp_targets; /* list all targets in this smp group/cluster
189  * The head of the list is shared between the
190  * cluster, thus here there is a pointer */
191  bool smp_halt_event_postponed; /* Some SMP implementations (currently Cortex-M) stores
192  * 'halted' events and emits them after all targets of
193  * the SMP group has been polled */
194 
195  /* the gdb service is there in case of smp, we have only one gdb server
196  * for all smp target
197  * the target attached to the gdb is changing dynamically by changing
198  * gdb_service->target pointer */
200 
201  /* file-I/O information for host to do syscall */
203 
204  char *gdb_port_override; /* target-specific override for gdb_port */
205 
206  int gdb_max_connections; /* max number of simultaneous gdb connections */
207 
208  /* The semihosting information, extracted from the target. */
210 };
211 
212 struct target_list {
213  struct list_head lh;
214  struct target *target;
215 };
216 
218  char *identifier;
219  uint64_t param_1;
220  uint64_t param_2;
221  uint64_t param_3;
222  uint64_t param_4;
223 };
224 
226 static inline const char *target_endianness(const struct target *target)
227 {
228  return (target->endianness == TARGET_ENDIAN_UNKNOWN) ? "unknown" :
229  (target->endianness == TARGET_BIG_ENDIAN) ? "big endian" : "little endian";
230 }
231 
233 static inline const char *target_name(const struct target *target)
234 {
235  return target->cmd_name;
236 }
237 
238 const char *debug_reason_name(const struct target *t);
239 
241 
242  /* allow GDB to do stuff before others handle the halted event,
243  * this is in lieu of defining ordering of invocation of events,
244  * which would be more complicated
245  *
246  * Telling GDB to halt does not mean that the target stopped running,
247  * simply that we're dropping out of GDB's waiting for step or continue.
248  *
249  * This can be useful when e.g. detecting power dropout.
250  */
252  TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
253  TARGET_EVENT_RESUMED, /* target resumed to normal execution */
258 
259  TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
260  TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
261 
264  TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
270 
271  TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
272  TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
273 
277 
280 
285 
287 
288  TARGET_EVENT_SEMIHOSTING_USER_CMD_0X100 = 0x100, /* semihosting allows user cmds from 0x100 to 0x1ff */
296 };
297 
298 bool target_has_event_action(const struct target *target, enum target_event event);
299 
301  int (*callback)(struct target *target, enum target_event event, void *priv);
302  void *priv;
304 };
305 
307  struct list_head list;
308  void *priv;
309  int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
310 };
311 
313  struct list_head list;
314  void *priv;
315  int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
316 };
317 
321 };
322 
324  int (*callback)(void *priv);
325  unsigned int time_ms;
326  enum target_timer_type type;
327  bool removed;
328  int64_t when; /* output of timeval_ms() */
329  void *priv;
331 };
332 
335  uint32_t size;
336  uint32_t result;
337 };
338 
339 int target_register_commands(struct command_context *cmd_ctx);
340 int target_examine(void);
341 
343  int (*callback)(struct target *target,
344  enum target_event event, void *priv),
345  void *priv);
347  int (*callback)(struct target *target,
348  enum target_event event, void *priv),
349  void *priv);
350 
352  int (*callback)(struct target *target,
353  enum target_reset_mode reset_mode, void *priv),
354  void *priv);
356  int (*callback)(struct target *target,
357  enum target_reset_mode reset_mode, void *priv),
358  void *priv);
359 
361  int (*callback)(struct target *target,
362  size_t len, uint8_t *data, void *priv),
363  void *priv);
365  int (*callback)(struct target *target,
366  size_t len, uint8_t *data, void *priv),
367  void *priv);
368 
369 /* Poll the status of the target, detect any error conditions and report them.
370  *
371  * Also note that this fn will clear such error conditions, so a subsequent
372  * invocation will then succeed.
373  *
374  * These error conditions can be "sticky" error conditions. E.g. writing
375  * to memory could be implemented as an open loop and if memory writes
376  * fails, then a note is made of it, the error is sticky, but the memory
377  * write loop still runs to completion. This improves performance in the
378  * normal case as there is no need to verify that every single write succeed,
379  * yet it is possible to detect error conditions.
380  */
381 int target_poll(struct target *target);
382 int target_resume(struct target *target, bool current, target_addr_t address,
383  bool handle_breakpoints, bool debug_execution);
384 int target_halt(struct target *target);
385 int target_call_event_callbacks(struct target *target, enum target_event event);
386 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
387 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
388 
393 int target_register_timer_callback(int (*callback)(void *priv),
394  unsigned int time_ms, enum target_timer_type type, void *priv);
395 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
406 int64_t target_timer_next_event(void);
407 
408 struct target *get_current_target(struct command_context *cmd_ctx);
409 struct target *get_current_target_or_null(struct command_context *cmd_ctx);
410 struct target *get_target(const char *id);
411 
418 const char *target_type_name(const struct target *target);
419 
426 int target_examine_one(struct target *target);
427 
429 static inline bool target_was_examined(const struct target *target)
430 {
431  return target->examined;
432 }
433 
436 static inline void target_set_examined(struct target *target)
437 {
438  target->examined = true;
439 }
440 
447  struct breakpoint *breakpoint);
454  struct breakpoint *breakpoint);
461  struct breakpoint *breakpoint);
469  struct breakpoint *breakpoint);
476  struct watchpoint *watchpoint);
483  struct watchpoint *watchpoint);
484 
491  struct watchpoint **watchpoint);
492 
498 const char *target_get_gdb_arch(const struct target *target);
499 
506  struct reg **reg_list[], int *reg_list_size,
507  enum target_register_class reg_class);
508 
516  struct reg **reg_list[], int *reg_list_size,
517  enum target_register_class reg_class);
518 
524 bool target_supports_gdb_connection(const struct target *target);
525 
531 int target_step(struct target *target,
532  bool current, target_addr_t address, bool handle_breakpoints);
539  int num_mem_params, struct mem_param *mem_params,
540  int num_reg_params, struct reg_param *reg_param,
541  target_addr_t entry_point, target_addr_t exit_point,
542  unsigned int timeout_ms, void *arch_info);
543 
550  int num_mem_params, struct mem_param *mem_params,
551  int num_reg_params, struct reg_param *reg_params,
552  target_addr_t entry_point, target_addr_t exit_point,
553  void *arch_info);
554 
561  int num_mem_params, struct mem_param *mem_params,
562  int num_reg_params, struct reg_param *reg_params,
563  target_addr_t exit_point, unsigned int timeout_ms,
564  void *arch_info);
565 
571  const uint8_t *buffer, uint32_t count, int block_size,
572  int num_mem_params, struct mem_param *mem_params,
573  int num_reg_params, struct reg_param *reg_params,
574  uint32_t buffer_start, uint32_t buffer_size,
575  uint32_t entry_point, uint32_t exit_point,
576  void *arch_info);
577 
583  uint8_t *buffer, uint32_t count, int block_size,
584  int num_mem_params, struct mem_param *mem_params,
585  int num_reg_params, struct reg_param *reg_params,
586  uint32_t buffer_start, uint32_t buffer_size,
587  uint32_t entry_point, uint32_t exit_point,
588  void *arch_info);
589 
596 int target_read_memory(struct target *target,
597  target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
599  target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
617 int target_write_memory(struct target *target,
618  target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
620  target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
621 
622 /*
623  * Write to target memory using the virtual address.
624  *
625  * Note that this fn is used to implement software breakpoints. Targets
626  * can implement support for software breakpoints to memory marked as read
627  * only by making this fn write to ram even if it is read only(MMU or
628  * MPUs).
629  *
630  * It is sufficient to implement for writing a single word(16 or 32 in
631  * ARM32/16 bit case) to write the breakpoint to ram.
632  *
633  * The target should also take care of "other things" to make sure that
634  * software breakpoints can be written using this function. E.g.
635  * when there is a separate instruction and data cache, this fn must
636  * make sure that the instruction cache is synced up to the potential
637  * code change that can happen as a result of the memory write(typically
638  * by invalidating the cache).
639  *
640  * The high level wrapper fn in target.c will break down this memory write
641  * request to multiple write requests to the target driver to e.g. guarantee
642  * that writing 4 bytes to an aligned address happens with a single 32 bit
643  * write operation, thus making this fn suitable to e.g. write to special
644  * peripheral registers which do not support byte operations.
645  */
646 int target_write_buffer(struct target *target,
647  target_addr_t address, uint32_t size, const uint8_t *buffer);
648 int target_read_buffer(struct target *target,
649  target_addr_t address, uint32_t size, uint8_t *buffer);
651  target_addr_t address, uint32_t size, uint32_t *crc);
653  struct target_memory_check_block *blocks, int num_blocks,
654  uint8_t erased_value);
655 int target_wait_state(struct target *target, enum target_state state, unsigned int ms);
656 
663 
669 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
670 
675 
681 unsigned int target_address_bits(struct target *target);
682 
688 unsigned int target_data_bits(struct target *target);
689 
691 const char *target_state_name(const struct target *target);
692 
694 const char *target_event_name(enum target_event event);
695 
697 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
698 
699 /* DANGER!!!!!
700  *
701  * if "area" passed in to target_alloc_working_area() points to a memory
702  * location that goes out of scope (e.g. a pointer on the stack), then
703  * the caller of target_alloc_working_area() is responsible for invoking
704  * target_free_working_area() before "area" goes out of scope.
705  *
706  * target_free_all_working_areas() will NULL out the "area" pointer
707  * upon resuming or resetting the CPU.
708  *
709  */
711  uint32_t size, struct working_area **area);
712 /* Same as target_alloc_working_area, except that no error is logged
713  * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
714  *
715  * This allows the calling code to *try* to allocate target memory
716  * and have a fallback to another behaviour(slower?).
717  */
719  uint32_t size, struct working_area **area);
727 int target_free_working_area(struct target *target, struct working_area *area);
730 
734 void target_quit(void);
735 
736 extern struct target *all_targets;
737 
738 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
739 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
740 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
741 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
742 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
743 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
744 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
745 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
746 
747 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
748 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
749 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
750 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
751 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
752 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
753 
754 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
755 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
756 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
757 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
758 int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
759 int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
760 int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
761 int target_write_u8(struct target *target, target_addr_t address, uint8_t value);
762 
763 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
764 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
765 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
766 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
767 
768 /* Issues USER() statements with target state information */
769 int target_arch_state(struct target *target);
770 
771 void target_handle_event(struct target *t, enum target_event e);
772 
774  struct target *target, target_addr_t address, unsigned int size,
775  unsigned int count, const uint8_t *buffer);
776 
777 int target_profiling_default(struct target *target, uint32_t *samples, uint32_t
778  max_num_samples, uint32_t *num_samples, uint32_t seconds);
779 
780 #define ERROR_TARGET_INVALID (-300)
781 #define ERROR_TARGET_INIT_FAILED (-301)
782 #define ERROR_TARGET_TIMEOUT (-302)
783 #define ERROR_TARGET_NOT_HALTED (-304)
784 #define ERROR_TARGET_FAILURE (-305)
785 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
786 #define ERROR_TARGET_DATA_ABORT (-307)
787 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
788 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
789 #define ERROR_TARGET_NOT_RUNNING (-310)
790 #define ERROR_TARGET_NOT_EXAMINED (-311)
791 #define ERROR_TARGET_DUPLICATE_BREAKPOINT (-312)
792 #define ERROR_TARGET_ALGO_EXIT (-313)
793 #define ERROR_TARGET_SIZE_NOT_SUPPORTED (-314)
794 #define ERROR_TARGET_PACKING_NOT_SUPPORTED (-315)
795 #define ERROR_TARGET_HALTED_DO_RESUME (-316) /* used to workaround incorrect debug halt */
796 
797 extern bool get_target_reset_nag(void);
798 
799 #define TARGET_DEFAULT_POLLING_INTERVAL 100
800 
801 const char *target_debug_reason_str(enum target_debug_reason reason);
802 
803 #endif /* OPENOCD_TARGET_TARGET_H */
uint64_t buffer
Pointer to data buffer to send over SPI.
Definition: dw-spi-helper.h:0
uint32_t size
Size of dw_spi_transaction::buffer.
Definition: dw-spi-helper.h:4
uint32_t buffer_size
Size of dw_spi_program::buffer.
Definition: dw-spi-helper.h:5
uint32_t address
Starting address. Sector aligned.
Definition: dw-spi-helper.h:0
uint8_t type
Definition: esp_usb_jtag.c:0
static struct esp_usb_jtag * priv
Definition: esp_usb_jtag.c:219
struct target * target
Definition: rtt/rtt.c:26
When run_command is called, a new instance will be created on the stack, filled with the proper value...
Definition: command.h:76
uint64_t param_1
Definition: target.h:219
uint64_t param_4
Definition: target.h:222
uint64_t param_3
Definition: target.h:221
char * identifier
Definition: target.h:218
uint64_t param_2
Definition: target.h:220
int32_t core[2]
Definition: target.h:100
struct target * target
Definition: target.h:95
Definition: jtag.h:101
Definition: list.h:41
Definition: register.h:111
Definition: rtos.h:36
int(* callback)(struct target *target, enum target_event event, void *priv)
Definition: target.h:301
struct target_event_callback * next
Definition: target.h:303
struct list_head lh
Definition: target.h:213
struct target * target
Definition: target.h:214
target_addr_t address
Definition: target.h:334
int(* callback)(struct target *target, enum target_reset_mode reset_mode, void *priv)
Definition: target.h:309
struct list_head list
Definition: target.h:307
int(* callback)(void *priv)
Definition: target.h:324
struct target_timer_callback * next
Definition: target.h:330
unsigned int time_ms
Definition: target.h:325
enum target_timer_type type
Definition: target.h:326
int(* callback)(struct target *target, size_t len, uint8_t *data, void *priv)
Definition: target.h:315
struct list_head list
Definition: target.h:313
This holds methods shared between all instances of a given target type.
Definition: target_type.h:26
Definition: target.h:116
int32_t coreid
Definition: target.h:120
struct semihosting * semihosting
Definition: target.h:209
target_addr_t working_area
Definition: target.h:145
target_addr_t working_area_virt
Definition: target.h:148
struct gdb_service * gdb_service
Definition: target.h:199
uint32_t working_area_size
Definition: target.h:151
struct jtag_tap * tap
Definition: target.h:119
bool dbgbase_set
Definition: target.h:174
struct trace * trace_info
Definition: target.h:161
bool dbg_msg_enabled
Definition: target.h:163
enum target_debug_reason debug_reason
Definition: target.h:154
enum target_state state
Definition: target.h:157
uint32_t dbgbase
Definition: target.h:175
void * private_config
Definition: target.h:165
char * gdb_port_override
Definition: target.h:204
enum target_endianness endianness
Definition: target.h:155
struct reg_cache * reg_cache
Definition: target.h:158
bool backup_working_area
Definition: target.h:152
bool halt_issued
Definition: target.h:170
struct list_head * smp_targets
Definition: target.h:188
struct breakpoint * breakpoints
Definition: target.h:159
struct working_area * working_areas
Definition: target.h:153
bool verbose_halt_msg
Definition: target.h:168
bool dap_configured
Definition: target.h:179
struct rtos * rtos
Definition: target.h:183
struct gdb_fileio_info * fileio_info
Definition: target.h:202
struct debug_msg_receiver * dbgmsg
Definition: target.h:162
bool rtos_auto_detect
Definition: target.h:184
int64_t halt_issued_time
Definition: target.h:171
unsigned int smp
Definition: target.h:187
struct list_head events_action
Definition: target.h:142
struct target_type * type
Definition: target.h:117
struct backoff_timer backoff
Definition: target.h:186
target_addr_t working_area_phys
Definition: target.h:150
bool has_dap
Definition: target.h:178
bool tap_configured
Definition: target.h:180
struct watchpoint * watchpoints
Definition: target.h:160
bool working_area_phys_spec
Definition: target.h:149
bool running_alg
true if the target is currently running a downloaded "algorithm" instead of arbitrary user code.
Definition: target.h:140
void * arch_info
Definition: target.h:164
int gdb_max_connections
Definition: target.h:206
bool working_area_virt_spec
Definition: target.h:147
bool smp_halt_event_postponed
Definition: target.h:191
bool reset_halt
Definition: target.h:144
bool examined
Indicates whether this target has been examined.
Definition: target.h:131
char * cmd_name
Definition: target.h:118
bool defer_examine
Should we defer examine to later.
Definition: target.h:123
struct target * next
Definition: target.h:166
Definition: trace.h:21
uint32_t size
Definition: target.h:87
bool free
Definition: target.h:88
struct working_area * next
Definition: target.h:91
target_addr_t address
Definition: target.h:86
struct working_area ** user
Definition: target.h:90
uint8_t * backup
Definition: target.h:89
void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
Definition: target.c:409
void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
Definition: target.c:369
int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info)
Obtain file-I/O information from target for GDB to do syscall.
Definition: target.c:1435
int target_add_watchpoint(struct target *target, struct watchpoint *watchpoint)
Add the watchpoint for target.
Definition: target.c:1338
target_debug_reason
Definition: target.h:68
@ DBG_REASON_WPTANDBKPT
Definition: target.h:72
@ DBG_REASON_UNDEFINED
Definition: target.h:77
@ DBG_REASON_EXIT
Definition: target.h:75
@ DBG_REASON_NOTHALTED
Definition: target.h:74
@ DBG_REASON_DBGRQ
Definition: target.h:69
@ DBG_REASON_SINGLESTEP
Definition: target.h:73
@ DBG_REASON_WATCHPOINT
Definition: target.h:71
@ DBG_REASON_EXC_CATCH
Definition: target.h:76
@ DBG_REASON_BREAKPOINT
Definition: target.h:70
struct target * all_targets
Definition: target.c:115
int target_run_read_async_algorithm(struct target *target, uint8_t *buffer, uint32_t count, int block_size, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_params, uint32_t buffer_start, uint32_t buffer_size, uint32_t entry_point, uint32_t exit_point, void *arch_info)
This routine is a wrapper for asynchronous algorithms.
Definition: target.c:1092
int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value)
Definition: target.c:2730
uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer)
Definition: target.c:315
int target_call_event_callbacks(struct target *target, enum target_event event)
Definition: target.c:1773
struct target * get_target(const char *id)
Definition: target.c:441
void target_free_all_working_areas(struct target *target)
Definition: target.c:2159
int target_unregister_reset_callback(int(*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv), void *priv)
Definition: target.c:1719
target_reset_mode
Definition: target.h:61
@ RESET_RUN
Definition: target.h:63
@ RESET_HALT
Definition: target.h:64
@ RESET_UNKNOWN
Definition: target.h:62
@ RESET_INIT
Definition: target.h:65
target_register_class
Definition: target.h:110
@ REG_CLASS_GENERAL
Definition: target.h:112
@ REG_CLASS_ALL
Definition: target.h:111
int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value)
Definition: target.c:2709
int target_unregister_event_callback(int(*callback)(struct target *target, enum target_event event, void *priv), void *priv)
Definition: target.c:1696
int target_hit_watchpoint(struct target *target, struct watchpoint **watchpoint)
Find out the just hit watchpoint for target.
Definition: target.c:1352
int target_read_phys_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
Definition: target.c:1260
int target_register_event_callback(int(*callback)(struct target *target, enum target_event event, void *priv), void *priv)
Definition: target.c:1601
int target_write_phys_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
Definition: target.c:1288
int target_halt(struct target *target)
Definition: target.c:515
int target_get_gdb_reg_list_noread(struct target *target, struct reg **reg_list[], int *reg_list_size, enum target_register_class reg_class)
Obtain the registers for GDB, but don't read register values from the target.
Definition: target.c:1399
static bool target_was_examined(const struct target *target)
Definition: target.h:429
bool target_supports_gdb_connection(const struct target *target)
Check if target allows GDB connections.
Definition: target.c:1410
int target_arch_state(struct target *target)
Definition: target.c:2267
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
Definition: target.c:378
int target_call_timer_callbacks_now(void)
Invoke this to ensure that e.g.
Definition: target.c:1893
int target_remove_breakpoint(struct target *target, struct breakpoint *breakpoint)
Remove the breakpoint for target.
Definition: target.c:1332
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
Definition: target.c:360
int target_register_commands(struct command_context *cmd_ctx)
Definition: target.c:6265
int target_checksum_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t *crc)
Definition: target.c:2475
int target_write_buffer(struct target *target, target_addr_t address, uint32_t size, const uint8_t *buffer)
Definition: target.c:2350
int target_add_hybrid_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the ContextID & IVA breakpoint for target.
Definition: target.c:1322
int target_write_u8(struct target *target, target_addr_t address, uint8_t value)
Definition: target.c:2691
int target_add_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the breakpoint for target.
Definition: target.c:1302
target_addr_t target_address_max(struct target *target)
Return the highest accessible address for this target.
Definition: target.c:1453
int target_write_u16(struct target *target, target_addr_t address, uint16_t value)
Definition: target.c:2670
int target_unregister_timer_callback(int(*callback)(void *priv), void *priv)
Definition: target.c:1757
int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c)
Pass GDB file-I/O response to target after finishing host syscall.
Definition: target.c:1444
int target_read_buffer(struct target *target, target_addr_t address, uint32_t size, uint8_t *buffer)
Definition: target.c:2415
int target_unregister_trace_callback(int(*callback)(struct target *target, size_t len, uint8_t *data, void *priv), void *priv)
Definition: target.c:1738
int target_read_u8(struct target *target, target_addr_t address, uint8_t *value)
Definition: target.c:2606
int target_blank_check_memory(struct target *target, struct target_memory_check_block *blocks, int num_blocks, uint8_t erased_value)
Definition: target.c:2519
int target_run_algorithm(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, target_addr_t entry_point, target_addr_t exit_point, unsigned int timeout_ms, void *arch_info)
Run an algorithm on the target given.
Definition: target.c:782
target_timer_type
Definition: target.h:318
@ TARGET_TIMER_TYPE_PERIODIC
Definition: target.h:320
@ TARGET_TIMER_TYPE_ONESHOT
Definition: target.h:319
target_event
Definition: target.h:240
@ TARGET_EVENT_DEBUG_RESUMED
Definition: target.h:272
@ TARGET_EVENT_EXAMINE_START
Definition: target.h:274
@ TARGET_EVENT_RESET_START
Definition: target.h:262
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X106
Definition: target.h:294
@ TARGET_EVENT_GDB_FLASH_WRITE_END
Definition: target.h:284
@ TARGET_EVENT_RESET_END
Definition: target.h:269
@ TARGET_EVENT_RESET_ASSERT_POST
Definition: target.h:265
@ TARGET_EVENT_RESET_DEASSERT_POST
Definition: target.h:267
@ TARGET_EVENT_HALTED
Definition: target.h:252
@ TARGET_EVENT_RESUMED
Definition: target.h:253
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X102
Definition: target.h:290
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X107
Definition: target.h:295
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X105
Definition: target.h:293
@ TARGET_EVENT_EXAMINE_FAIL
Definition: target.h:275
@ TARGET_EVENT_GDB_START
Definition: target.h:259
@ TARGET_EVENT_EXAMINE_END
Definition: target.h:276
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X104
Definition: target.h:292
@ TARGET_EVENT_RESET_INIT
Definition: target.h:268
@ TARGET_EVENT_GDB_END
Definition: target.h:260
@ TARGET_EVENT_RESET_DEASSERT_PRE
Definition: target.h:266
@ TARGET_EVENT_GDB_FLASH_ERASE_START
Definition: target.h:281
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X103
Definition: target.h:291
@ TARGET_EVENT_DEBUG_HALTED
Definition: target.h:271
@ TARGET_EVENT_RESET_ASSERT_PRE
Definition: target.h:263
@ TARGET_EVENT_RESET_ASSERT
Definition: target.h:264
@ TARGET_EVENT_GDB_FLASH_WRITE_START
Definition: target.h:283
@ TARGET_EVENT_RESUME_START
Definition: target.h:254
@ TARGET_EVENT_STEP_END
Definition: target.h:257
@ TARGET_EVENT_STEP_START
Definition: target.h:256
@ TARGET_EVENT_GDB_ATTACH
Definition: target.h:278
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X100
Definition: target.h:288
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X101
Definition: target.h:289
@ TARGET_EVENT_RESUME_END
Definition: target.h:255
@ TARGET_EVENT_GDB_FLASH_ERASE_END
Definition: target.h:282
@ TARGET_EVENT_GDB_DETACH
Definition: target.h:279
@ TARGET_EVENT_TRACE_CONFIG
Definition: target.h:286
@ TARGET_EVENT_GDB_HALT
Definition: target.h:251
static const char * target_name(const struct target *target)
Returns the instance-specific name of the specified target.
Definition: target.h:233
unsigned int target_address_bits(struct target *target)
Return the number of address bits this target supports.
Definition: target.c:1462
int target_profiling_default(struct target *target, uint32_t *samples, uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
Definition: target.c:2298
int target_write_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
Write count items of size bytes to the memory of target at the address given.
Definition: target.c:1274
int target_get_gdb_reg_list(struct target *target, struct reg **reg_list[], int *reg_list_size, enum target_register_class reg_class)
Obtain the registers for GDB.
Definition: target.c:1377
int target_call_timer_callbacks(void)
Definition: target.c:1887
int target_write_u64(struct target *target, target_addr_t address, uint64_t value)
Definition: target.c:2628
target_state
Definition: target.h:53
@ TARGET_RESET
Definition: target.h:57
@ TARGET_DEBUG_RUNNING
Definition: target.h:58
@ TARGET_UNKNOWN
Definition: target.h:54
@ TARGET_HALTED
Definition: target.h:56
@ TARGET_RUNNING
Definition: target.h:55
struct target * get_current_target_or_null(struct command_context *cmd_ctx)
Definition: target.c:478
target_endianness
Definition: target.h:80
@ TARGET_BIG_ENDIAN
Definition: target.h:82
@ TARGET_ENDIAN_UNKNOWN
Definition: target.h:81
@ TARGET_LITTLE_ENDIAN
Definition: target.h:82
const char * target_debug_reason_str(enum target_debug_reason reason)
Definition: target.c:6778
int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode)
Definition: target.c:1798
uint32_t target_get_working_area_avail(struct target *target)
Definition: target.c:2173
int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
Definition: target.c:2069
bool get_target_reset_nag(void)
Definition: target.c:6272
unsigned int target_data_bits(struct target *target)
Return the number of data bits this target supports.
Definition: target.c:1469
int target_remove_watchpoint(struct target *target, struct watchpoint *watchpoint)
Remove the watchpoint for target.
Definition: target.c:1347
const char * target_event_name(enum target_event event)
Return the name of a target event enumeration value.
Definition: target.c:283
int target_write_u32(struct target *target, target_addr_t address, uint32_t value)
Definition: target.c:2649
int target_examine_one(struct target *target)
Examine the specified target, letting it perform any Initialisation that requires JTAG access.
Definition: target.c:681
int target_poll(struct target *target)
Definition: target.c:485
int target_free_working_area(struct target *target, struct working_area *area)
Free a working area.
Definition: target.c:2127
int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
Definition: target.c:1975
int target_register_timer_callback(int(*callback)(void *priv), unsigned int time_ms, enum target_timer_type type, void *priv)
The period is very approximate, the callback can happen much more often or much more rarely than spec...
Definition: target.c:1667
static void target_set_examined(struct target *target)
Sets the examined flag for the given target.
Definition: target.h:436
int target_read_u16(struct target *target, target_addr_t address, uint16_t *value)
Definition: target.c:2582
int target_run_flash_async_algorithm(struct target *target, const uint8_t *buffer, uint32_t count, int block_size, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_params, uint32_t buffer_start, uint32_t buffer_size, uint32_t entry_point, uint32_t exit_point, void *arch_info)
This routine is a wrapper for asynchronous algorithms.
Definition: target.c:939
void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value)
Definition: target.c:351
void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf)
Definition: target.c:417
int target_add_context_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the ContextID breakpoint for target.
Definition: target.c:1312
int target_resume(struct target *target, bool current, target_addr_t address, bool handle_breakpoints, bool debug_execution)
Make the target (re)start executing using its saved execution context (possibly with some modificatio...
Definition: target.c:564
int target_read_u32(struct target *target, target_addr_t address, uint32_t *value)
Definition: target.c:2558
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
Definition: target.c:342
int target_read_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
Read count items of size bytes from the memory of target at the address given.
Definition: target.c:1246
bool target_has_event_action(const struct target *target, enum target_event event)
Returns true only if the target has a handler for the specified event.
Definition: target.c:4831
void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf)
Definition: target.c:393
const char * debug_reason_name(const struct target *t)
Definition: target.c:255
void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf)
Definition: target.c:433
int target_register_reset_callback(int(*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv), void *priv)
Definition: target.c:1623
uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
Definition: target.c:333
void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
Definition: target.c:401
int64_t target_timer_next_event(void)
Returns when the next registered event will take place.
Definition: target.c:1898
void target_handle_md_output(struct command_invocation *cmd, struct target *target, target_addr_t address, unsigned int size, unsigned int count, const uint8_t *buffer)
Definition: target.c:3353
int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value)
Definition: target.c:2751
void target_handle_event(struct target *t, enum target_event e)
Definition: target.c:4667
const char * target_get_gdb_arch(const struct target *target)
Obtain the architecture for GDB.
Definition: target.c:1370
int target_wait_algorithm(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_params, target_addr_t exit_point, unsigned int timeout_ms, void *arch_info)
Wait for an algorithm on the target given.
Definition: target.c:867
int target_wait_state(struct target *target, enum target_state state, unsigned int ms)
Definition: target.c:3221
const char * target_state_name(const struct target *target)
Return the name of this targets current state.
Definition: target.c:268
int target_step(struct target *target, bool current, target_addr_t address, bool handle_breakpoints)
Step the target.
Definition: target.c:1419
int target_examine(void)
Definition: target.c:720
int target_register_trace_callback(int(*callback)(struct target *target, size_t len, uint8_t *data, void *priv), void *priv)
Definition: target.c:1645
struct target * get_current_target(struct command_context *cmd_ctx)
Definition: target.c:466
void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf)
Definition: target.c:425
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
Definition: target.c:324
const char * target_type_name(const struct target *target)
Get the target type name.
Definition: target.c:745
int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data)
Definition: target.c:1811
int target_start_algorithm(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_params, target_addr_t entry_point, target_addr_t exit_point, void *arch_info)
Starts an algorithm in the background on the target given.
Definition: target.c:823
void target_quit(void)
Free all the resources allocated by targets and the target layer.
Definition: target.c:2238
int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value)
Definition: target.c:2772
int target_read_u64(struct target *target, target_addr_t address, uint64_t *value)
Definition: target.c:2534
const char * target_reset_mode_name(enum target_reset_mode reset_mode)
Return the name of a target reset reason enumeration value.
Definition: target.c:294
uint64_t target_addr_t
Definition: types.h:335
uint8_t cmd
Definition: vdebug.c:1
uint8_t state[4]
Definition: vdebug.c:21
uint8_t count[4]
Definition: vdebug.c:22