1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
24 #include "breakpoints.h"
25 #include "algorithm.h"
35 struct command_context_s
;
37 TARGET_UNKNOWN = 0: we don't know anything about the target yet
38 TARGET_RUNNING = 1: the target is executing user code
39 TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
40 debugger. on an xscale it means that the debug handler is executing
41 TARGET_RESET = 3: the target is being held in reset (only a temporary state,
42 not sure how this is used with all the recent changes)
43 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
44 behalf of the debugger (e.g. algorithm for flashing)
52 TARGET_DEBUG_RUNNING
= 4,
55 extern char *target_state_strings
[];
57 enum daemon_startup_mode
59 DAEMON_ATTACH
, /* simply attach to the target */
60 DAEMON_RESET
, /* reset target (behaviour defined by reset_mode */
63 extern enum daemon_startup_mode startup_mode
;
65 enum target_reset_mode
67 RESET_RUN
= 0, /* reset and let target run */
68 RESET_HALT
= 1, /* reset and halt target out of reset */
69 RESET_INIT
= 2, /* reset and halt target out of reset, then run init script */
70 RESET_RUN_AND_HALT
= 3, /* reset and let target run, halt after n milliseconds */
71 RESET_RUN_AND_INIT
= 4, /* reset and let target run, halt after n milliseconds, then run init script */
74 enum target_debug_reason
77 DBG_REASON_BREAKPOINT
= 1,
78 DBG_REASON_WATCHPOINT
= 2,
79 DBG_REASON_WPTANDBKPT
= 3,
80 DBG_REASON_SINGLESTEP
= 4,
81 DBG_REASON_NOTHALTED
= 5,
82 DBG_REASON_UNDEFINED
= 6
85 extern char *target_debug_reason_strings
[];
89 TARGET_BIG_ENDIAN
= 0, TARGET_LITTLE_ENDIAN
= 1
92 extern char *target_endianess_strings
[];
96 typedef struct working_area_s
102 struct working_area_s
**user
;
103 struct working_area_s
*next
;
106 typedef struct target_type_s
110 /* poll current target status */
111 int (*poll
)(struct target_s
*target
);
112 /* Invoked only from target_arch_state().
113 * Issue USER() w/architecture specific status. */
114 int (*arch_state
)(struct target_s
*target
);
116 /* target request support */
117 int (*target_request_data
)(struct target_s
*target
, u32 size
, u8
*buffer
);
119 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
120 int (*halt
)(struct target_s
*target
);
121 int (*resume
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
122 int (*step
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
);
124 /* target reset control */
125 int (*assert_reset
)(struct target_s
*target
);
126 int (*deassert_reset
)(struct target_s
*target
);
127 int (*soft_reset_halt
)(struct target_s
*target
);
128 int (*prepare_reset_halt
)(struct target_s
*target
);
130 /* target register access for gdb.
132 * Danger! this function will succeed even if the target is running
133 * and return a register list with dummy values.
135 * The reason is that GDB connection will fail without a valid register
136 * list, however it is after GDB is connected that monitor commands can
137 * be run to properly initialize the target
139 int (*get_gdb_reg_list
)(struct target_s
*target
, struct reg_s
**reg_list
[], int *reg_list_size
);
141 /* target memory access
142 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
143 * count: number of items of <size>
145 int (*read_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
146 int (*write_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
148 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
149 int (*bulk_write_memory
)(struct target_s
*target
, u32 address
, u32 count
, u8
*buffer
);
151 int (*checksum_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* checksum
);
153 /* target break-/watchpoint control
154 * rw: 0 = write, 1 = read, 2 = access
156 int (*add_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
157 int (*remove_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
158 int (*add_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
159 int (*remove_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
161 /* target algorithm support */
162 int (*run_algorithm
)(struct target_s
*target
, int num_mem_params
, mem_param_t
*mem_params
, int num_reg_params
, reg_param_t
*reg_param
, u32 entry_point
, u32 exit_point
, int timeout_ms
, void *arch_info
);
164 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
165 int (*target_command
)(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct target_s
*target
);
166 int (*init_target
)(struct command_context_s
*cmd_ctx
, struct target_s
*target
);
169 int (*virt2phys
)(struct target_s
*target
, u32 address
, u32
*physical
);
170 int (*mmu
)(struct target_s
*target
, int *enabled
);
174 typedef struct target_s
176 target_type_t
*type
; /* target type definition (name, access functions) */
177 enum target_reset_mode reset_mode
; /* what to do after a reset */
178 int run_and_halt_time
; /* how long the target should run after a run_and_halt reset */
179 char *reset_script
; /* script file to initialize the target after a reset */
180 char *post_halt_script
; /* script file to execute after the target halted */
181 char *pre_resume_script
; /* script file to execute before the target resumed */
182 char *gdb_program_script
; /* script file to execute before programming vis gdb */
183 u32 working_area
; /* working area (initialized RAM). Evaluated
184 upon first allocation from virtual/physical address.
186 u32 working_area_virt
; /* virtual address */
187 u32 working_area_phys
; /* physical address */
188 u32 working_area_size
; /* size in bytes */
189 u32 backup_working_area
; /* whether the content of the working area has to be preserved */
190 struct working_area_s
*working_areas
;/* list of allocated working areas */
191 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
192 enum target_endianess endianness
; /* target endianess */
193 enum target_state state
; /* the current backend-state (running, halted, ...) */
194 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
195 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
196 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
197 struct trace_s
*trace_info
; /* generic trace information */
198 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
199 u32 dbg_msg_enabled
; /* debug message status */
200 void *arch_info
; /* architecture specific information */
201 struct target_s
*next
; /* next target in list */
206 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
207 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
208 TARGET_EVENT_RESET
, /* target entered reset */
209 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
210 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
211 TARGET_EVENT_GDB_PROGRAM
/* target about to be be programmed by gdb */
214 typedef struct target_event_callback_s
216 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
218 struct target_event_callback_s
*next
;
219 } target_event_callback_t
;
221 typedef struct target_timer_callback_s
223 int (*callback
)(void *priv
);
228 struct target_timer_callback_s
*next
;
229 } target_timer_callback_t
;
231 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
232 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
233 extern int target_init(struct command_context_s
*cmd_ctx
);
234 extern int target_init_reset(struct command_context_s
*cmd_ctx
);
235 extern int handle_target(void *priv
);
236 extern int target_process_reset(struct command_context_s
*cmd_ctx
);
238 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
239 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
240 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
242 /* The period is very approximate, the callback can happen much more often
243 * or much more rarely than specified
245 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
246 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
247 extern int target_call_timer_callbacks_now();
248 /* invoke this to ensure that e.g. polling timer callbacks happen before
249 * a syncrhonous command completes.
251 extern int target_call_timer_callbacks_now_now();
253 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
254 extern int get_num_by_target(target_t
*query_target
);
255 extern target_t
* get_target_by_num(int num
);
257 extern int target_write_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
258 extern int target_read_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
259 extern int target_checksum_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* crc
);
261 extern int target_alloc_working_area(struct target_s
*target
, u32 size
, working_area_t
**area
);
262 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
263 extern int target_free_all_working_areas(struct target_s
*target
);
265 extern target_t
*targets
;
267 extern target_event_callback_t
*target_event_callbacks
;
268 extern target_timer_callback_t
*target_timer_callbacks
;
270 extern u32
target_buffer_get_u32(target_t
*target
, u8
*buffer
);
271 extern u16
target_buffer_get_u16(target_t
*target
, u8
*buffer
);
272 extern void target_buffer_set_u32(target_t
*target
, u8
*buffer
, u32 value
);
273 extern void target_buffer_set_u16(target_t
*target
, u8
*buffer
, u16 value
);
275 int target_read_u32(struct target_s
*target
, u32 address
, u32
*value
);
276 int target_read_u16(struct target_s
*target
, u32 address
, u16
*value
);
277 int target_read_u8(struct target_s
*target
, u32 address
, u8
*value
);
278 int target_write_u32(struct target_s
*target
, u32 address
, u32 value
);
279 int target_write_u16(struct target_s
*target
, u32 address
, u16 value
);
280 int target_write_u8(struct target_s
*target
, u32 address
, u8 value
);
282 /* Issues USER() statements with target state information */
283 int target_arch_state(struct target_s
*target
);
285 #define ERROR_TARGET_INVALID (-300)
286 #define ERROR_TARGET_INIT_FAILED (-301)
287 #define ERROR_TARGET_TIMEOUT (-302)
288 #define ERROR_TARGET_NOT_HALTED (-304)
289 #define ERROR_TARGET_FAILURE (-305)
290 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
291 #define ERROR_TARGET_DATA_ABORT (-307)
292 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
293 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
295 #endif /* TARGET_H */
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)