1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
27 #include "breakpoints.h"
28 #include "algorithm.h"
38 struct command_context_s
;
40 TARGET_UNKNOWN = 0: we don't know anything about the target yet
41 TARGET_RUNNING = 1: the target is executing user code
42 TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
43 debugger. on an xscale it means that the debug handler is executing
44 TARGET_RESET = 3: the target is being held in reset (only a temporary state,
45 not sure how this is used with all the recent changes)
46 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
47 behalf of the debugger (e.g. algorithm for flashing)
55 TARGET_DEBUG_RUNNING
= 4,
58 extern char *target_state_strings
[];
60 enum target_reset_mode
62 RESET_RUN
= 0, /* reset and let target run */
63 RESET_HALT
= 1, /* reset and halt target out of reset */
64 RESET_INIT
= 2, /* reset and halt target out of reset, then run init script */
65 RESET_RUN_AND_HALT
= 3, /* reset and let target run, halt after n milliseconds */
66 RESET_RUN_AND_INIT
= 4, /* reset and let target run, halt after n milliseconds, then run init script */
69 enum target_debug_reason
72 DBG_REASON_BREAKPOINT
= 1,
73 DBG_REASON_WATCHPOINT
= 2,
74 DBG_REASON_WPTANDBKPT
= 3,
75 DBG_REASON_SINGLESTEP
= 4,
76 DBG_REASON_NOTHALTED
= 5,
77 DBG_REASON_UNDEFINED
= 6
80 extern char *target_debug_reason_strings
[];
84 TARGET_BIG_ENDIAN
= 0, TARGET_LITTLE_ENDIAN
= 1
87 extern char *target_endianess_strings
[];
91 typedef struct working_area_s
97 struct working_area_s
**user
;
98 struct working_area_s
*next
;
101 typedef struct target_type_s
107 /* poll current target status */
108 int (*poll
)(struct target_s
*target
);
109 /* Invoked only from target_arch_state().
110 * Issue USER() w/architecture specific status. */
111 int (*arch_state
)(struct target_s
*target
);
113 /* target request support */
114 int (*target_request_data
)(struct target_s
*target
, u32 size
, u8
*buffer
);
116 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
117 int (*halt
)(struct target_s
*target
);
118 int (*resume
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
119 int (*step
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
);
121 /* target reset control. assert reset can be invoked when OpenOCD and
122 * the target is out of sync.
124 * A typical example is that the target was power cycled while OpenOCD
125 * thought the target was halted or running.
127 * assert_reset() can therefore make no assumptions whatsoever about the
128 * state of the target
130 * Before assert_reset() for the target is invoked, a TRST/tms and
131 * chain validation is executed. TRST should not be asserted
132 * during target assert unless there is no way around it due to
133 * the way reset's are configured.
136 int (*assert_reset
)(struct target_s
*target
);
137 int (*deassert_reset
)(struct target_s
*target
);
138 int (*soft_reset_halt_imp
)(struct target_s
*target
);
139 int (*soft_reset_halt
)(struct target_s
*target
);
141 /* target register access for gdb.
143 * Danger! this function will succeed even if the target is running
144 * and return a register list with dummy values.
146 * The reason is that GDB connection will fail without a valid register
147 * list, however it is after GDB is connected that monitor commands can
148 * be run to properly initialize the target
150 int (*get_gdb_reg_list
)(struct target_s
*target
, struct reg_s
**reg_list
[], int *reg_list_size
);
152 /* target memory access
153 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
154 * count: number of items of <size>
156 int (*read_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
157 int (*read_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
158 int (*write_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
159 int (*write_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
161 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
162 int (*bulk_write_memory
)(struct target_s
*target
, u32 address
, u32 count
, u8
*buffer
);
164 int (*checksum_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* checksum
);
165 int (*blank_check_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* blank
);
167 /* target break-/watchpoint control
168 * rw: 0 = write, 1 = read, 2 = access
170 int (*add_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
171 int (*remove_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
172 int (*add_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
173 int (*remove_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
175 /* target algorithm support */
176 int (*run_algorithm_imp
)(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
);
177 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
);
179 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
180 int (*target_command
)(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct target_s
*target
);
181 /* invoked after JTAG chain has been examined & validated. During
182 * this stage the target is examined and any additional setup is
185 * invoked every time after the jtag chain has been validated/examined
187 int (*examine
)(struct command_context_s
*cmd_ctx
, struct target_s
*target
);
188 /* Set up structures for target.
190 * It is illegal to talk to the target at this stage as this fn is invoked
191 * before the JTAG chain has been examined/verified
193 int (*init_target
)(struct command_context_s
*cmd_ctx
, struct target_s
*target
);
196 int (*virt2phys
)(struct target_s
*target
, u32 address
, u32
*physical
);
197 int (*mmu
)(struct target_s
*target
, int *enabled
);
201 typedef struct target_s
203 target_type_t
*type
; /* target type definition (name, access functions) */
204 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
205 int run_and_halt_time
; /* how long the target should run after a run_and_halt reset */
206 u32 working_area
; /* working area (initialized RAM). Evaluated
207 upon first allocation from virtual/physical address. */
208 u32 working_area_virt
; /* virtual address */
209 u32 working_area_phys
; /* physical address */
210 u32 working_area_size
; /* size in bytes */
211 u32 backup_working_area
; /* whether the content of the working area has to be preserved */
212 struct working_area_s
*working_areas
;/* list of allocated working areas */
213 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
214 enum target_endianess endianness
; /* target endianess */
215 enum target_state state
; /* the current backend-state (running, halted, ...) */
216 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
217 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
218 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
219 struct trace_s
*trace_info
; /* generic trace information */
220 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
221 u32 dbg_msg_enabled
; /* debug message status */
222 void *arch_info
; /* architecture specific information */
223 struct target_s
*next
; /* next target in list */
228 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
229 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
230 TARGET_EVENT_RESET
, /* target entered reset */
231 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
232 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
233 TARGET_EVENT_GDB_PROGRAM
/* target about to be be programmed by gdb */
236 typedef struct target_event_callback_s
238 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
240 struct target_event_callback_s
*next
;
241 } target_event_callback_t
;
243 typedef struct target_timer_callback_s
245 int (*callback
)(void *priv
);
250 struct target_timer_callback_s
*next
;
251 } target_timer_callback_t
;
253 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
254 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
255 extern int target_init(struct command_context_s
*cmd_ctx
);
256 extern int target_examine(struct command_context_s
*cmd_ctx
);
257 extern int handle_target(void *priv
);
258 extern int target_process_reset(struct command_context_s
*cmd_ctx
, enum target_reset_mode reset_mode
);
260 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
261 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
262 extern int target_poll(target_t
*target
);
263 extern int target_resume(target_t
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
264 extern int target_halt(target_t
*target
);
265 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
267 /* The period is very approximate, the callback can happen much more often
268 * or much more rarely than specified
270 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
271 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
272 extern int target_call_timer_callbacks();
273 /* invoke this to ensure that e.g. polling timer callbacks happen before
274 * a syncrhonous command completes.
276 extern int target_call_timer_callbacks_now();
278 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
279 extern int get_num_by_target(target_t
*query_target
);
280 extern target_t
* get_target_by_num(int num
);
282 extern int target_write_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
283 extern int target_read_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
284 extern int target_checksum_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* crc
);
285 extern int target_blank_check_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* blank
);
286 extern int target_wait_state(target_t
*target
, enum target_state state
, int ms
);
290 * if "area" passed in to target_alloc_working_area() points to a memory
291 * location that goes out of scope (e.g. a pointer on the stack), then
292 * the caller of target_alloc_working_area() is responsible for invoking
293 * target_free_working_area() before "area" goes out of scope.
295 * target_free_all_working_areas() will NULL out the "area" pointer
296 * upon resuming or resetting the CPU.
299 extern int target_alloc_working_area(struct target_s
*target
, u32 size
, working_area_t
**area
);
300 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
301 extern int target_free_working_area_restore(struct target_s
*target
, working_area_t
*area
, int restore
);
302 extern int target_free_all_working_areas(struct target_s
*target
);
303 extern int target_free_all_working_areas_restore(struct target_s
*target
, int restore
);
305 extern target_t
*targets
;
307 extern target_event_callback_t
*target_event_callbacks
;
308 extern target_timer_callback_t
*target_timer_callbacks
;
310 extern u32
target_buffer_get_u32(target_t
*target
, u8
*buffer
);
311 extern u16
target_buffer_get_u16(target_t
*target
, u8
*buffer
);
312 extern void target_buffer_set_u32(target_t
*target
, u8
*buffer
, u32 value
);
313 extern void target_buffer_set_u16(target_t
*target
, u8
*buffer
, u16 value
);
315 int target_read_u32(struct target_s
*target
, u32 address
, u32
*value
);
316 int target_read_u16(struct target_s
*target
, u32 address
, u16
*value
);
317 int target_read_u8(struct target_s
*target
, u32 address
, u8
*value
);
318 int target_write_u32(struct target_s
*target
, u32 address
, u32 value
);
319 int target_write_u16(struct target_s
*target
, u32 address
, u16 value
);
320 int target_write_u8(struct target_s
*target
, u32 address
, u8 value
);
322 /* Issues USER() statements with target state information */
323 int target_arch_state(struct target_s
*target
);
325 int target_invoke_script(struct command_context_s
*cmd_ctx
, target_t
*target
, char *name
);
327 #define ERROR_TARGET_INVALID (-300)
328 #define ERROR_TARGET_INIT_FAILED (-301)
329 #define ERROR_TARGET_TIMEOUT (-302)
330 #define ERROR_TARGET_NOT_HALTED (-304)
331 #define ERROR_TARGET_FAILURE (-305)
332 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
333 #define ERROR_TARGET_DATA_ABORT (-307)
334 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
335 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
336 #define ERROR_TARGET_NOT_RUNNING (-310)
338 #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)