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  * TARGET_UNAVAILABLE = 5: The target is unavailable for some reason. It might
50  * be powered down, for instance.
51  *
52  * also see: target_state_name();
53  */
54 
62 };
63 
66  RESET_RUN = 1, /* reset and let target run */
67  RESET_HALT = 2, /* reset and halt target out of reset */
68  RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
69 };
70 
81 };
82 
86 };
87 
88 struct working_area {
90  uint32_t size;
91  bool free;
92  uint8_t *backup;
93  struct working_area **user;
94  struct working_area *next;
95 };
96 
97 struct gdb_service {
98  struct target *target;
99  /* field for smp display */
100  /* element 0 coreid currently displayed ( 1 till n) */
101  /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
102  * all cores core displayed */
103  int32_t core[2];
104 };
105 
106 /* target back off timer */
108  int64_t next_attempt;
109  unsigned int interval;
110 };
111 
112 /* split target registers into multiple class */
116 };
117 
118 /* target_type.h contains the full definition of struct target_type */
119 struct target {
120  struct target_type *type; /* target type definition (name, access functions) */
121  char *cmd_name; /* tcl Name of target */
122  struct jtag_tap *tap; /* where on the jtag chain is this */
123  int32_t coreid; /* which device on the TAP? */
124 
127 
135  bool examined;
142 
151 
152  struct list_head events_action;
153 
154  bool reset_halt; /* attempt resetting the CPU into the halted mode? */
155  target_addr_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  target_addr_t working_area_virt; /* virtual address */
159  bool working_area_phys_spec; /* physical address specified? */
160  target_addr_t working_area_phys; /* physical address */
161  uint32_t working_area_size; /* size in bytes */
162  bool 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  bool dbg_msg_enabled; /* debug message status */
174  void *arch_info; /* architecture specific information */
175  void *private_config; /* pointer to target specific config data (for jim_configure hook) */
176  struct target *next; /* next target in list */
177 
178  bool verbose_halt_msg; /* display async info in telnet session. Do not display
179  * lots of halted/resumed info when stepping in debugger. */
180  bool halt_issued; /* did we transition to halted state? */
181  int64_t halt_issued_time; /* Note time when halt was issued */
182 
183  /* ARM v7/v8 targets with ADIv5 interface */
184  bool dbgbase_set; /* By default the debug base is not set */
185  uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
186  * system in place to support target specific options
187  * currently. */
188  bool has_dap; /* set to true if target has ADIv5 support */
189  bool dap_configured; /* set to true if ADIv5 DAP is configured */
190  bool tap_configured; /* set to true if JTAG tap has been configured
191  * through -tap */
192 
193  struct rtos *rtos; /* Instance of Real Time Operating System support */
194  bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
195  * and must be detected when symbols are offered */
196  /* Track when next to poll(). If polling is failing, we don't want to
197  * poll too quickly because we'll just overwhelm the user with error
198  * messages. */
199  struct backoff_timer backoff;
200  bool smp; /* set to true if smp is enabled */
201  unsigned int smp_id; /* Unique non-zero number for each SMP group */
202  struct list_head *smp_targets; /* list all targets in this smp group/cluster
203  * The head of the list is shared between the
204  * cluster, thus here there is a pointer */
205  bool smp_halt_event_postponed; /* Some SMP implementations (currently Cortex-M) stores
206  * 'halted' events and emits them after all targets of
207  * the SMP group has been polled */
208 
209  /* the gdb service is there in case of smp, we have only one gdb server
210  * for all smp target
211  * the target attached to the gdb is changing dynamically by changing
212  * gdb_service->target pointer */
214 
215  /* file-I/O information for host to do syscall */
217 
218  char *gdb_port_override; /* target-specific override for gdb_port */
219 
220  int gdb_max_connections; /* max number of simultaneous gdb connections */
221 
222  /* The semihosting information, extracted from the target. */
224 };
225 
226 struct target_list {
227  struct list_head lh;
228  struct target *target;
229 };
230 
232  char *identifier;
233  uint64_t param_1;
234  uint64_t param_2;
235  uint64_t param_3;
236  uint64_t param_4;
237 };
238 
240 static inline const char *target_endianness(const struct target *target)
241 {
242  return (target->endianness == TARGET_ENDIAN_UNKNOWN) ? "unknown" :
243  (target->endianness == TARGET_BIG_ENDIAN) ? "big endian" : "little endian";
244 }
245 
247 static inline const char *target_name(const struct target *target)
248 {
249  return target->cmd_name;
250 }
251 
252 const char *debug_reason_name(const struct target *t);
253 
255 
256  /* allow GDB to do stuff before others handle the halted event,
257  * this is in lieu of defining ordering of invocation of events,
258  * which would be more complicated
259  *
260  * Telling GDB to halt does not mean that the target stopped running,
261  * simply that we're dropping out of GDB's waiting for step or continue.
262  *
263  * This can be useful when e.g. detecting power dropout.
264  */
266  TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
267  TARGET_EVENT_RESUMED, /* target resumed to normal execution */
272 
273  TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
274  TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
275 
278  TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
284 
285  TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
286  TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
287 
291 
294 
299 
301 
302  TARGET_EVENT_SEMIHOSTING_USER_CMD_0X100 = 0x100, /* semihosting allows user cmds from 0x100 to 0x1ff */
310 };
311 
312 bool target_has_event_action(const struct target *target, enum target_event event);
313 
315  int (*callback)(struct target *target, enum target_event event, void *priv);
316  void *priv;
318 };
319 
321  struct list_head list;
322  void *priv;
323  int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
324 };
325 
327  struct list_head list;
328  void *priv;
329  int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
330 };
331 
335 };
336 
338  int (*callback)(void *priv);
339  unsigned int time_ms;
340  enum target_timer_type type;
341  bool removed;
342  int64_t when; /* output of timeval_ms() */
343  void *priv;
345 };
346 
349  uint32_t size;
350  uint32_t result;
351 };
352 
353 int target_register_commands(struct command_context *cmd_ctx);
354 int target_examine(void);
355 
357  int (*callback)(struct target *target,
358  enum target_event event, void *priv),
359  void *priv);
361  int (*callback)(struct target *target,
362  enum target_event event, void *priv),
363  void *priv);
364 
366  int (*callback)(struct target *target,
367  enum target_reset_mode reset_mode, void *priv),
368  void *priv);
370  int (*callback)(struct target *target,
371  enum target_reset_mode reset_mode, void *priv),
372  void *priv);
373 
375  int (*callback)(struct target *target,
376  size_t len, uint8_t *data, void *priv),
377  void *priv);
379  int (*callback)(struct target *target,
380  size_t len, uint8_t *data, void *priv),
381  void *priv);
382 
383 /* Poll the status of the target, detect any error conditions and report them.
384  *
385  * Also note that this fn will clear such error conditions, so a subsequent
386  * invocation will then succeed.
387  *
388  * These error conditions can be "sticky" error conditions. E.g. writing
389  * to memory could be implemented as an open loop and if memory writes
390  * fails, then a note is made of it, the error is sticky, but the memory
391  * write loop still runs to completion. This improves performance in the
392  * normal case as there is no need to verify that every single write succeed,
393  * yet it is possible to detect error conditions.
394  */
395 int target_poll(struct target *target);
396 int target_resume(struct target *target, bool current, target_addr_t address,
397  bool handle_breakpoints, bool debug_execution);
398 int target_halt(struct target *target);
399 int target_call_event_callbacks(struct target *target, enum target_event event);
400 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
401 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
402 
407 int target_register_timer_callback(int (*callback)(void *priv),
408  unsigned int time_ms, enum target_timer_type type, void *priv);
409 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
420 int64_t target_timer_next_event(void);
421 
422 struct target *get_current_target(struct command_context *cmd_ctx);
423 struct target *get_current_target_or_null(struct command_context *cmd_ctx);
424 struct target *get_target(const char *id);
425 
432 const char *target_type_name(const struct target *target);
433 
440 int target_examine_one(struct target *target);
441 
444 static inline bool target_was_examined(const struct target *target)
445 {
446  return target->examined;
447 }
448 
452 static inline bool target_active_polled(const struct target *target)
453 {
454  return target->active_polled;
455 }
456 
461 static inline void target_set_examined(struct target *target)
462 {
463  target->active_polled = true;
464  target->examined = true;
465 }
466 
473  struct breakpoint *breakpoint);
480  struct breakpoint *breakpoint);
487  struct breakpoint *breakpoint);
495  struct breakpoint *breakpoint);
502  struct watchpoint *watchpoint);
509  struct watchpoint *watchpoint);
510 
517  struct watchpoint **watchpoint);
518 
524 const char *target_get_gdb_arch(const struct target *target);
525 
532  struct reg **reg_list[], int *reg_list_size,
533  enum target_register_class reg_class);
534 
542  struct reg **reg_list[], int *reg_list_size,
543  enum target_register_class reg_class);
544 
550 bool target_supports_gdb_connection(const struct target *target);
551 
557 int target_step(struct target *target,
558  bool current, target_addr_t address, bool handle_breakpoints);
565  int num_mem_params, struct mem_param *mem_params,
566  int num_reg_params, struct reg_param *reg_param,
567  target_addr_t entry_point, target_addr_t exit_point,
568  unsigned int timeout_ms, void *arch_info);
569 
576  int num_mem_params, struct mem_param *mem_params,
577  int num_reg_params, struct reg_param *reg_params,
578  target_addr_t entry_point, target_addr_t exit_point,
579  void *arch_info);
580 
587  int num_mem_params, struct mem_param *mem_params,
588  int num_reg_params, struct reg_param *reg_params,
589  target_addr_t exit_point, unsigned int timeout_ms,
590  void *arch_info);
591 
597  const uint8_t *buffer, uint32_t count, int block_size,
598  int num_mem_params, struct mem_param *mem_params,
599  int num_reg_params, struct reg_param *reg_params,
600  uint32_t buffer_start, uint32_t buffer_size,
601  uint32_t entry_point, uint32_t exit_point,
602  void *arch_info);
603 
609  uint8_t *buffer, uint32_t count, int block_size,
610  int num_mem_params, struct mem_param *mem_params,
611  int num_reg_params, struct reg_param *reg_params,
612  uint32_t buffer_start, uint32_t buffer_size,
613  uint32_t entry_point, uint32_t exit_point,
614  void *arch_info);
615 
623 bool target_memory_ready(struct target *target);
624 
631 int target_read_memory(struct target *target,
632  target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
634  target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
652 int target_write_memory(struct target *target,
653  target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
655  target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
656 
657 /*
658  * Write to target memory using the virtual address.
659  *
660  * Note that this fn is used to implement software breakpoints. Targets
661  * can implement support for software breakpoints to memory marked as read
662  * only by making this fn write to ram even if it is read only(MMU or
663  * MPUs).
664  *
665  * It is sufficient to implement for writing a single word(16 or 32 in
666  * ARM32/16 bit case) to write the breakpoint to ram.
667  *
668  * The target should also take care of "other things" to make sure that
669  * software breakpoints can be written using this function. E.g.
670  * when there is a separate instruction and data cache, this fn must
671  * make sure that the instruction cache is synced up to the potential
672  * code change that can happen as a result of the memory write(typically
673  * by invalidating the cache).
674  *
675  * The high level wrapper fn in target.c will break down this memory write
676  * request to multiple write requests to the target driver to e.g. guarantee
677  * that writing 4 bytes to an aligned address happens with a single 32 bit
678  * write operation, thus making this fn suitable to e.g. write to special
679  * peripheral registers which do not support byte operations.
680  */
681 int target_write_buffer(struct target *target,
682  target_addr_t address, uint32_t size, const uint8_t *buffer);
683 int target_read_buffer(struct target *target,
684  target_addr_t address, uint32_t size, uint8_t *buffer);
686  target_addr_t address, uint32_t size, uint32_t *crc);
688  struct target_memory_check_block *blocks, unsigned int num_blocks,
689  uint8_t erased_value, unsigned int *checked);
690 int target_wait_state(struct target *target, enum target_state state, unsigned int ms);
691 
698 
704 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
705 
710 
716 unsigned int target_address_bits(struct target *target);
717 
723 unsigned int target_data_bits(struct target *target);
724 
726 const char *target_state_name(const struct target *target);
727 
729 const char *target_event_name(enum target_event event);
730 
732 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
733 
734 /* DANGER!!!!!
735  *
736  * if "area" passed in to target_alloc_working_area() points to a memory
737  * location that goes out of scope (e.g. a pointer on the stack), then
738  * the caller of target_alloc_working_area() is responsible for invoking
739  * target_free_working_area() before "area" goes out of scope.
740  *
741  * target_free_all_working_areas() will NULL out the "area" pointer
742  * upon resuming or resetting the CPU.
743  *
744  */
746  uint32_t size, struct working_area **area);
747 /* Same as target_alloc_working_area, except that no error is logged
748  * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
749  *
750  * This allows the calling code to *try* to allocate target memory
751  * and have a fallback to another behaviour(slower?).
752  */
754  uint32_t size, struct working_area **area);
762 int target_free_working_area(struct target *target, struct working_area *area);
765 
769 void target_quit(void);
770 
771 extern struct target *all_targets;
772 
773 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
774 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
775 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
776 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
777 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
778 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
779 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
780 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
781 
782 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
783 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
784 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
785 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
786 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
787 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
788 
789 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
790 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
791 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
792 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
793 int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
794 int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
795 int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
796 int target_write_u8(struct target *target, target_addr_t address, uint8_t value);
797 
798 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
799 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
800 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
801 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
802 
803 /* Issues USER() statements with target state information */
804 int target_arch_state(struct target *target);
805 
806 void target_handle_event(struct target *t, enum target_event e);
807 
809  struct target *target, target_addr_t address, unsigned int size,
810  unsigned int count, const uint8_t *buffer, bool include_address);
811 
812 int target_profiling_default(struct target *target, uint32_t *samples, uint32_t
813  max_num_samples, uint32_t *num_samples, uint32_t seconds);
814 
815 #define ERROR_TARGET_INVALID (-300)
816 #define ERROR_TARGET_INIT_FAILED (-301)
817 #define ERROR_TARGET_TIMEOUT (-302)
818 #define ERROR_TARGET_NOT_HALTED (-304)
819 #define ERROR_TARGET_FAILURE (-305)
820 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
821 #define ERROR_TARGET_DATA_ABORT (-307)
822 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
823 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
824 #define ERROR_TARGET_NOT_RUNNING (-310)
825 #define ERROR_TARGET_NOT_EXAMINED (-311)
826 #define ERROR_TARGET_ALGO_EXIT (-312)
827 #define ERROR_TARGET_SIZE_NOT_SUPPORTED (-313)
828 #define ERROR_TARGET_PACKING_NOT_SUPPORTED (-314)
829 #define ERROR_TARGET_HALTED_DO_RESUME (-315) /* used to workaround incorrect debug halt */
830 
831 extern bool get_target_reset_nag(void);
832 
833 #define TARGET_DEFAULT_POLLING_INTERVAL 100u
834 #define TARGET_MAX_POLLING_INTERVAL_MS 5000u
835 
836 const char *target_debug_reason_str(enum target_debug_reason reason);
837 
838 #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
int64_t next_attempt
Definition: target.h:108
unsigned int interval
Definition: target.h:109
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:233
uint64_t param_4
Definition: target.h:236
uint64_t param_3
Definition: target.h:235
char * identifier
Definition: target.h:232
uint64_t param_2
Definition: target.h:234
int32_t core[2]
Definition: target.h:103
struct target * target
Definition: target.h:98
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:315
struct target_event_callback * next
Definition: target.h:317
struct list_head lh
Definition: target.h:227
struct target * target
Definition: target.h:228
target_addr_t address
Definition: target.h:348
int(* callback)(struct target *target, enum target_reset_mode reset_mode, void *priv)
Definition: target.h:323
struct list_head list
Definition: target.h:321
int(* callback)(void *priv)
Definition: target.h:338
struct target_timer_callback * next
Definition: target.h:344
unsigned int time_ms
Definition: target.h:339
enum target_timer_type type
Definition: target.h:340
int(* callback)(struct target *target, size_t len, uint8_t *data, void *priv)
Definition: target.h:329
struct list_head list
Definition: target.h:327
This holds methods shared between all instances of a given target type.
Definition: target_type.h:27
Definition: target.h:119
int32_t coreid
Definition: target.h:123
struct semihosting * semihosting
Definition: target.h:223
target_addr_t working_area
Definition: target.h:155
target_addr_t working_area_virt
Definition: target.h:158
struct gdb_service * gdb_service
Definition: target.h:213
uint32_t working_area_size
Definition: target.h:161
struct jtag_tap * tap
Definition: target.h:122
bool dbgbase_set
Definition: target.h:184
struct trace * trace_info
Definition: target.h:171
bool dbg_msg_enabled
Definition: target.h:173
enum target_debug_reason debug_reason
Definition: target.h:164
enum target_state state
Definition: target.h:167
bool active_polled
The flag is set after a successful examine call.
Definition: target.h:141
uint32_t dbgbase
Definition: target.h:185
void * private_config
Definition: target.h:175
char * gdb_port_override
Definition: target.h:218
enum target_endianness endianness
Definition: target.h:165
struct reg_cache * reg_cache
Definition: target.h:168
bool backup_working_area
Definition: target.h:162
bool halt_issued
Definition: target.h:180
struct list_head * smp_targets
Definition: target.h:202
struct breakpoint * breakpoints
Definition: target.h:169
bool smp
Definition: target.h:200
struct working_area * working_areas
Definition: target.h:163
bool verbose_halt_msg
Definition: target.h:178
bool dap_configured
Definition: target.h:189
struct rtos * rtos
Definition: target.h:193
struct gdb_fileio_info * fileio_info
Definition: target.h:216
struct debug_msg_receiver * dbgmsg
Definition: target.h:172
bool rtos_auto_detect
Definition: target.h:194
int64_t halt_issued_time
Definition: target.h:181
struct list_head events_action
Definition: target.h:152
unsigned int smp_id
Definition: target.h:201
struct target_type * type
Definition: target.h:120
struct backoff_timer backoff
Definition: target.h:199
target_addr_t working_area_phys
Definition: target.h:160
bool has_dap
Definition: target.h:188
bool tap_configured
Definition: target.h:190
struct watchpoint * watchpoints
Definition: target.h:170
bool working_area_phys_spec
Definition: target.h:159
bool running_alg
true if the target is currently running a downloaded "algorithm" instead of arbitrary user code.
Definition: target.h:150
void * arch_info
Definition: target.h:174
int gdb_max_connections
Definition: target.h:220
bool working_area_virt_spec
Definition: target.h:157
bool smp_halt_event_postponed
Definition: target.h:205
bool reset_halt
Definition: target.h:154
bool examined
Indicates whether this target has been examined, remembers the last result of examine call.
Definition: target.h:135
char * cmd_name
Definition: target.h:121
bool defer_examine
Should we defer examine to later.
Definition: target.h:126
struct target * next
Definition: target.h:176
Definition: trace.h:21
uint32_t size
Definition: target.h:90
bool free
Definition: target.h:91
struct working_area * next
Definition: target.h:94
target_addr_t address
Definition: target.h:89
struct working_area ** user
Definition: target.h:93
uint8_t * backup
Definition: target.h:92
void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
Definition: target.c:412
void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
Definition: target.c:372
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:1456
int target_add_watchpoint(struct target *target, struct watchpoint *watchpoint)
Add the watchpoint for target.
Definition: target.c:1353
target_debug_reason
Definition: target.h:71
@ DBG_REASON_WPTANDBKPT
Definition: target.h:75
@ DBG_REASON_UNDEFINED
Definition: target.h:80
@ DBG_REASON_EXIT
Definition: target.h:78
@ DBG_REASON_NOTHALTED
Definition: target.h:77
@ DBG_REASON_DBGRQ
Definition: target.h:72
@ DBG_REASON_SINGLESTEP
Definition: target.h:76
@ DBG_REASON_WATCHPOINT
Definition: target.h:74
@ DBG_REASON_EXC_CATCH
Definition: target.h:79
@ DBG_REASON_BREAKPOINT
Definition: target.h:73
struct target * all_targets
Definition: target.c:117
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:1099
int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value)
Definition: target.c:2741
uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer)
Definition: target.c:318
int target_call_event_callbacks(struct target *target, enum target_event event)
Definition: target.c:1816
struct target * get_target(const char *id)
Definition: target.c:444
void target_free_all_working_areas(struct target *target)
Definition: target.c:2206
int target_unregister_reset_callback(int(*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv), void *priv)
Definition: target.c:1749
target_reset_mode
Definition: target.h:64
@ RESET_RUN
Definition: target.h:66
@ RESET_HALT
Definition: target.h:67
@ RESET_UNKNOWN
Definition: target.h:65
@ RESET_INIT
Definition: target.h:68
target_register_class
Definition: target.h:113
@ REG_CLASS_GENERAL
Definition: target.h:115
@ REG_CLASS_ALL
Definition: target.h:114
int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value)
Definition: target.c:2724
int target_unregister_event_callback(int(*callback)(struct target *target, enum target_event event, void *priv), void *priv)
Definition: target.c:1726
int target_hit_watchpoint(struct target *target, struct watchpoint **watchpoint)
Find out the just hit watchpoint for target.
Definition: target.c:1367
int target_read_phys_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
Definition: target.c:1275
int target_register_event_callback(int(*callback)(struct target *target, enum target_event event, void *priv), void *priv)
Definition: target.c:1623
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:1303
int target_halt(struct target *target)
Definition: target.c:518
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:1415
static bool target_was_examined(const struct target *target)
Definition: target.h:444
bool target_supports_gdb_connection(const struct target *target)
Check if target allows GDB connections.
Definition: target.c:1426
int target_arch_state(struct target *target)
Definition: target.c:2319
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
Definition: target.c:381
int target_call_timer_callbacks_now(void)
Invoke this to ensure that e.g.
Definition: target.c:1936
static bool target_active_polled(const struct target *target)
Definition: target.h:452
int target_remove_breakpoint(struct target *target, struct breakpoint *breakpoint)
Remove the breakpoint for target.
Definition: target.c:1347
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
Definition: target.c:363
int target_register_commands(struct command_context *cmd_ctx)
Definition: target.c:6374
int target_checksum_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t *crc)
Definition: target.c:2535
int target_write_buffer(struct target *target, target_addr_t address, uint32_t size, const uint8_t *buffer)
Definition: target.c:2410
int target_add_hybrid_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the ContextID & IVA breakpoint for target.
Definition: target.c:1337
int target_write_u8(struct target *target, target_addr_t address, uint8_t value)
Definition: target.c:2710
int target_add_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the breakpoint for target.
Definition: target.c:1317
target_addr_t target_address_max(struct target *target)
Return the highest accessible address for this target.
Definition: target.c:1474
int target_write_u16(struct target *target, target_addr_t address, uint16_t value)
Definition: target.c:2693
int target_unregister_timer_callback(int(*callback)(void *priv), void *priv)
Definition: target.c:1802
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:1465
int target_read_buffer(struct target *target, target_addr_t address, uint32_t size, uint8_t *buffer)
Definition: target.c:2475
int target_unregister_trace_callback(int(*callback)(struct target *target, size_t len, uint8_t *data, void *priv), void *priv)
Definition: target.c:1768
int target_read_u8(struct target *target, target_addr_t address, uint8_t *value)
Definition: target.c:2642
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:787
target_timer_type
Definition: target.h:332
@ TARGET_TIMER_TYPE_PERIODIC
Definition: target.h:334
@ TARGET_TIMER_TYPE_ONESHOT
Definition: target.h:333
target_event
Definition: target.h:254
@ TARGET_EVENT_DEBUG_RESUMED
Definition: target.h:286
@ TARGET_EVENT_EXAMINE_START
Definition: target.h:288
@ TARGET_EVENT_RESET_START
Definition: target.h:276
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X106
Definition: target.h:308
@ TARGET_EVENT_GDB_FLASH_WRITE_END
Definition: target.h:298
@ TARGET_EVENT_RESET_END
Definition: target.h:283
@ TARGET_EVENT_RESET_ASSERT_POST
Definition: target.h:279
@ TARGET_EVENT_RESET_DEASSERT_POST
Definition: target.h:281
@ TARGET_EVENT_HALTED
Definition: target.h:266
@ TARGET_EVENT_RESUMED
Definition: target.h:267
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X102
Definition: target.h:304
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X107
Definition: target.h:309
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X105
Definition: target.h:307
@ TARGET_EVENT_EXAMINE_FAIL
Definition: target.h:289
@ TARGET_EVENT_GDB_START
Definition: target.h:273
@ TARGET_EVENT_EXAMINE_END
Definition: target.h:290
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X104
Definition: target.h:306
@ TARGET_EVENT_RESET_INIT
Definition: target.h:282
@ TARGET_EVENT_GDB_END
Definition: target.h:274
@ TARGET_EVENT_RESET_DEASSERT_PRE
Definition: target.h:280
@ TARGET_EVENT_GDB_FLASH_ERASE_START
Definition: target.h:295
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X103
Definition: target.h:305
@ TARGET_EVENT_DEBUG_HALTED
Definition: target.h:285
@ TARGET_EVENT_RESET_ASSERT_PRE
Definition: target.h:277
@ TARGET_EVENT_RESET_ASSERT
Definition: target.h:278
@ TARGET_EVENT_GDB_FLASH_WRITE_START
Definition: target.h:297
@ TARGET_EVENT_RESUME_START
Definition: target.h:268
@ TARGET_EVENT_STEP_END
Definition: target.h:271
@ TARGET_EVENT_STEP_START
Definition: target.h:270
@ TARGET_EVENT_GDB_ATTACH
Definition: target.h:292
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X100
Definition: target.h:302
@ TARGET_EVENT_SEMIHOSTING_USER_CMD_0X101
Definition: target.h:303
@ TARGET_EVENT_RESUME_END
Definition: target.h:269
@ TARGET_EVENT_GDB_FLASH_ERASE_END
Definition: target.h:296
@ TARGET_EVENT_GDB_DETACH
Definition: target.h:293
@ TARGET_EVENT_TRACE_CONFIG
Definition: target.h:300
@ TARGET_EVENT_GDB_HALT
Definition: target.h:265
static const char * target_name(const struct target *target)
Returns the instance-specific name of the specified target.
Definition: target.h:247
unsigned int target_address_bits(struct target *target)
Return the number of address bits this target supports.
Definition: target.c:1483
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:2348
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:1289
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:1392
int target_call_timer_callbacks(void)
Definition: target.c:1930
int target_write_u64(struct target *target, target_addr_t address, uint64_t value)
Definition: target.c:2659
target_state
Definition: target.h:55
@ TARGET_RESET
Definition: target.h:59
@ TARGET_DEBUG_RUNNING
Definition: target.h:60
@ TARGET_UNKNOWN
Definition: target.h:56
@ TARGET_UNAVAILABLE
Definition: target.h:61
@ TARGET_HALTED
Definition: target.h:58
@ TARGET_RUNNING
Definition: target.h:57
struct target * get_current_target_or_null(struct command_context *cmd_ctx)
Definition: target.c:481
target_endianness
Definition: target.h:83
@ TARGET_BIG_ENDIAN
Definition: target.h:85
@ TARGET_ENDIAN_UNKNOWN
Definition: target.h:84
@ TARGET_LITTLE_ENDIAN
Definition: target.h:85
const char * target_debug_reason_str(enum target_debug_reason reason)
Definition: target.c:6894
int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode)
Definition: target.c:1841
uint32_t target_get_working_area_avail(struct target *target)
Definition: target.c:2220
int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
Definition: target.c:2118
bool get_target_reset_nag(void)
Definition: target.c:6381
unsigned int target_data_bits(struct target *target)
Return the number of data bits this target supports.
Definition: target.c:1490
int target_remove_watchpoint(struct target *target, struct watchpoint *watchpoint)
Remove the watchpoint for target.
Definition: target.c:1362
const char * target_event_name(enum target_event event)
Return the name of a target event enumeration value.
Definition: target.c:286
int target_write_u32(struct target *target, target_addr_t address, uint32_t value)
Definition: target.c:2676
int target_examine_one(struct target *target)
Examine the specified target, letting it perform any Initialisation that requires JTAG access.
Definition: target.c:686
bool target_memory_ready(struct target *target)
Returns true if target memory is ready to read/write.
Definition: target.c:1253
int target_poll(struct target *target)
Definition: target.c:488
int target_free_working_area(struct target *target, struct working_area *area)
Free a working area.
Definition: target.c:2174
int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
Definition: target.c:2018
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:1701
static void target_set_examined(struct target *target)
Sets the examined and active_polled flags for the given target.
Definition: target.h:461
int target_read_u16(struct target *target, target_addr_t address, uint16_t *value)
Definition: target.c:2622
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:946
void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value)
Definition: target.c:354
void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf)
Definition: target.c:420
int target_add_context_breakpoint(struct target *target, struct breakpoint *breakpoint)
Add the ContextID breakpoint for target.
Definition: target.c:1327
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:567
int target_blank_check_memory(struct target *target, struct target_memory_check_block *blocks, unsigned int num_blocks, uint8_t erased_value, unsigned int *checked)
Definition: target.c:2566
int target_read_u32(struct target *target, target_addr_t address, uint32_t *value)
Definition: target.c:2602
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
Definition: target.c:345
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:1261
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:4885
void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf)
Definition: target.c:396
const char * debug_reason_name(const struct target *t)
Definition: target.c:258
void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf)
Definition: target.c:436
int target_register_reset_callback(int(*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv), void *priv)
Definition: target.c:1645
uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
Definition: target.c:336
void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
Definition: target.c:404
int64_t target_timer_next_event(void)
Returns when the next registered event will take place.
Definition: target.c:1941
int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value)
Definition: target.c:2758
void target_handle_event(struct target *t, enum target_event e)
Definition: target.c:4699
const char * target_get_gdb_arch(const struct target *target)
Obtain the architecture for GDB.
Definition: target.c:1385
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:874
int target_wait_state(struct target *target, enum target_state state, unsigned int ms)
Definition: target.c:3238
const char * target_state_name(const struct target *target)
Return the name of this targets current state.
Definition: target.c:271
int target_step(struct target *target, bool current, target_addr_t address, bool handle_breakpoints)
Step the target.
Definition: target.c:1435
int target_examine(void)
Definition: target.c:725
int target_register_trace_callback(int(*callback)(struct target *target, size_t len, uint8_t *data, void *priv), void *priv)
Definition: target.c:1667
struct target * get_current_target(struct command_context *cmd_ctx)
Definition: target.c:469
void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf)
Definition: target.c:428
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
Definition: target.c:327
const char * target_type_name(const struct target *target)
Get the target type name.
Definition: target.c:750
int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data)
Definition: target.c:1854
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:829
void target_quit(void)
Free all the resources allocated by targets and the target layer.
Definition: target.c:2290
int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value)
Definition: target.c:2775
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, bool include_address)
Definition: target.c:3368
int target_read_u64(struct target *target, target_addr_t address, uint64_t *value)
Definition: target.c:2582
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:297
uint64_t target_addr_t
Definition: types.h:279
uint8_t cmd
Definition: vdebug.c:1
uint8_t state[4]
Definition: vdebug.c:21
uint8_t count[4]
Definition: vdebug.c:22