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 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
29 #include "breakpoints.h"
30 #include "algorithm.h"
35 struct command_context_s
;
38 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
39 * TARGET_RUNNING = 1: the target is executing user code
40 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
41 * debugger. on an xscale it means that the debug handler is executing
42 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
43 * not sure how this is used with all the recent changes)
44 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
45 * behalf of the debugger (e.g. algorithm for flashing) */
53 TARGET_DEBUG_RUNNING
= 4,
56 extern const Jim_Nvp nvp_target_state
[];
63 extern const Jim_Nvp nvp_assert
[];
65 enum target_reset_mode
68 RESET_RUN
= 1, /* reset and let target run */
69 RESET_HALT
= 2, /* reset and halt target out of reset */
70 RESET_INIT
= 3, /* reset and halt target out of reset, then run init script */
73 extern const Jim_Nvp nvp_reset_mode
[];
75 enum target_debug_reason
78 DBG_REASON_BREAKPOINT
= 1,
79 DBG_REASON_WATCHPOINT
= 2,
80 DBG_REASON_WPTANDBKPT
= 3,
81 DBG_REASON_SINGLESTEP
= 4,
82 DBG_REASON_NOTHALTED
= 5,
83 DBG_REASON_UNDEFINED
= 6
86 extern const Jim_Nvp nvp_target_debug_reason
[];
90 TARGET_ENDIAN_UNKNOWN
=0,
91 TARGET_BIG_ENDIAN
= 1, TARGET_LITTLE_ENDIAN
= 2
94 extern const Jim_Nvp nvp_target_endian
[];
98 typedef struct working_area_s
104 struct working_area_s
**user
;
105 struct working_area_s
*next
;
108 typedef struct target_type_s
114 /* poll current target status */
115 int (*poll
)(struct target_s
*target
);
116 /* Invoked only from target_arch_state().
117 * Issue USER() w/architecture specific status. */
118 int (*arch_state
)(struct target_s
*target
);
120 /* target request support */
121 int (*target_request_data
)(struct target_s
*target
, u32 size
, u8
*buffer
);
123 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
124 int (*halt
)(struct target_s
*target
);
125 int (*resume
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
126 int (*step
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
);
128 /* target reset control. assert reset can be invoked when OpenOCD and
129 * the target is out of sync.
131 * A typical example is that the target was power cycled while OpenOCD
132 * thought the target was halted or running.
134 * assert_reset() can therefore make no assumptions whatsoever about the
135 * state of the target
137 * Before assert_reset() for the target is invoked, a TRST/tms and
138 * chain validation is executed. TRST should not be asserted
139 * during target assert unless there is no way around it due to
140 * the way reset's are configured.
143 int (*assert_reset
)(struct target_s
*target
);
144 int (*deassert_reset
)(struct target_s
*target
);
145 int (*soft_reset_halt_imp
)(struct target_s
*target
);
146 int (*soft_reset_halt
)(struct target_s
*target
);
148 /* target register access for gdb.
150 * Danger! this function will succeed even if the target is running
151 * and return a register list with dummy values.
153 * The reason is that GDB connection will fail without a valid register
154 * list, however it is after GDB is connected that monitor commands can
155 * be run to properly initialize the target
157 int (*get_gdb_reg_list
)(struct target_s
*target
, struct reg_s
**reg_list
[], int *reg_list_size
);
159 /* target memory access
160 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
161 * count: number of items of <size>
163 int (*read_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
165 * Target memory read callback. Do @b not call this function
166 * directly, use target_read_memory() instead.
168 int (*read_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
169 int (*write_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
171 * Target memory write callback. Do @b not call this function
172 * directly, use target_write_memory() instead.
174 int (*write_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
176 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
177 int (*bulk_write_memory
)(struct target_s
*target
, u32 address
, u32 count
, u8
*buffer
);
179 int (*checksum_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* checksum
);
180 int (*blank_check_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* blank
);
183 * target break-/watchpoint control
184 * rw: 0 = write, 1 = read, 2 = access
186 * Target must be halted while this is invoked as this
187 * will actually set up breakpoints on target.
189 * The breakpoint hardware will be set up upon adding the first breakpoint.
191 * Upon GDB connection all breakpoints/watchpoints are cleared.
193 int (*add_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
195 /* remove breakpoint. hw will only be updated if the target is currently halted.
196 * However, this method can be invoked on unresponsive targets.
198 int (*remove_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
199 int (*add_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
200 /* remove watchpoint. hw will only be updated if the target is currently halted.
201 * However, this method can be invoked on unresponsive targets.
203 int (*remove_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
205 /* target algorithm support */
206 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
);
208 * Target algorithm support. Do @b not call this method directly,
209 * use target_run_algorithm() instead.
211 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
);
213 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
215 /* called when target is created */
216 int (*target_create
)( struct target_s
*target
, Jim_Interp
*interp
);
218 /* called for various config parameters */
219 /* returns JIM_CONTINUE - if option not understood */
220 /* otherwise: JIM_OK, or JIM_ERR, */
221 int (*target_jim_configure
)( struct target_s
*target
, Jim_GetOptInfo
*goi
);
223 /* target commands specifically handled by the target */
224 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
225 int (*target_jim_commands
)( struct target_s
*target
, Jim_GetOptInfo
*goi
);
227 /* invoked after JTAG chain has been examined & validated. During
228 * this stage the target is examined and any additional setup is
231 * invoked every time after the jtag chain has been validated/examined
233 int (*examine
)(struct target_s
*target
);
234 /* Set up structures for target.
236 * It is illegal to talk to the target at this stage as this fn is invoked
237 * before the JTAG chain has been examined/verified
239 int (*init_target
)(struct command_context_s
*cmd_ctx
, struct target_s
*target
);
242 int (*virt2phys
)(struct target_s
*target
, u32 address
, u32
*physical
);
243 int (*mmu
)(struct target_s
*target
, int *enabled
);
247 /* forward decloration */
248 typedef struct target_event_action_s target_event_action_t
;
250 typedef struct target_s
252 target_type_t
*type
; /* target type definition (name, access functions) */
253 const char *cmd_name
; /* tcl Name of target */
254 int target_number
; /* generaly, target index but may not be in order */
255 jtag_tap_t
*tap
; /* where on the jtag chain is this */
256 const char *variant
; /* what varient of this chip is it? */
257 target_event_action_t
*event_action
;
259 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
260 u32 working_area
; /* working area (initialized RAM). Evaluated
261 * upon first allocation from virtual/physical address. */
262 u32 working_area_virt
; /* virtual address */
263 u32 working_area_phys
; /* physical address */
264 u32 working_area_size
; /* size in bytes */
265 u32 backup_working_area
; /* whether the content of the working area has to be preserved */
266 struct working_area_s
*working_areas
;/* list of allocated working areas */
267 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
268 enum target_endianess endianness
; /* target endianess */
269 enum target_state state
; /* the current backend-state (running, halted, ...) */
270 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
271 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
272 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
273 struct trace_s
*trace_info
; /* generic trace information */
274 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
275 u32 dbg_msg_enabled
; /* debug message status */
276 void *arch_info
; /* architecture specific information */
277 struct target_s
*next
; /* next target in list */
279 int display
; /* display async info in telnet session. Do not display
280 * lots of halted/resumed info when stepping in debugger. */
285 /* LD historical names
286 * - Prior to the great TCL change
287 * - June/July/Aug 2008
289 TARGET_EVENT_OLD_gdb_program_config
,
290 TARGET_EVENT_OLD_pre_reset
,
291 TARGET_EVENT_OLD_post_reset
,
292 TARGET_EVENT_OLD_pre_resume
,
294 /* allow GDB to do stuff before others handle the halted event,
295 * this is in lieu of defining ordering of invocation of events,
296 * which would be more complicated */
297 TARGET_EVENT_EARLY_HALTED
,
298 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
299 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
300 TARGET_EVENT_RESUME_START
,
301 TARGET_EVENT_RESUME_END
,
303 TARGET_EVENT_GDB_START
, /* debugger started execution (step/run) */
304 TARGET_EVENT_GDB_END
, /* debugger stopped execution (step/run) */
306 TARGET_EVENT_RESET_START
,
307 TARGET_EVENT_RESET_ASSERT_PRE
,
308 TARGET_EVENT_RESET_ASSERT_POST
,
309 TARGET_EVENT_RESET_DEASSERT_PRE
,
310 TARGET_EVENT_RESET_DEASSERT_POST
,
311 TARGET_EVENT_RESET_HALT_PRE
,
312 TARGET_EVENT_RESET_HALT_POST
,
313 TARGET_EVENT_RESET_WAIT_PRE
,
314 TARGET_EVENT_RESET_WAIT_POST
,
315 TARGET_EVENT_RESET_INIT
,
316 TARGET_EVENT_RESET_END
,
318 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
319 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
321 TARGET_EVENT_EXAMINE_START
,
322 TARGET_EVENT_EXAMINE_END
,
324 TARGET_EVENT_GDB_ATTACH
,
325 TARGET_EVENT_GDB_DETACH
,
327 TARGET_EVENT_GDB_FLASH_ERASE_START
,
328 TARGET_EVENT_GDB_FLASH_ERASE_END
,
329 TARGET_EVENT_GDB_FLASH_WRITE_START
,
330 TARGET_EVENT_GDB_FLASH_WRITE_END
,
333 struct target_event_action_s
{
334 enum target_event event
;
337 target_event_action_t
*next
;
340 typedef struct target_event_callback_s
342 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
344 struct target_event_callback_s
*next
;
345 } target_event_callback_t
;
347 typedef struct target_timer_callback_s
349 int (*callback
)(void *priv
);
354 struct target_timer_callback_s
*next
;
355 } target_timer_callback_t
;
357 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
358 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
359 extern int target_init(struct command_context_s
*cmd_ctx
);
360 extern int target_examine(void);
361 extern int handle_target(void *priv
);
362 extern int target_process_reset(struct command_context_s
*cmd_ctx
, enum target_reset_mode reset_mode
);
364 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
365 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
366 extern int target_poll(target_t
*target
);
367 extern int target_resume(target_t
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
368 extern int target_halt(target_t
*target
);
369 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
371 /* The period is very approximate, the callback can happen much more often
372 * or much more rarely than specified
374 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
375 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
376 extern int target_call_timer_callbacks(void);
377 /* invoke this to ensure that e.g. polling timer callbacks happen before
378 * a syncrhonous command completes.
380 extern int target_call_timer_callbacks_now(void);
382 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
383 extern int get_num_by_target(target_t
*query_target
);
384 extern target_t
*get_target(const char *id
);
387 * Run an algorithm on the @a target given.
389 * This routine is a wrapper for target->type->run_algorithm.
391 extern int target_run_algorithm(struct target_s
*target
,
392 int num_mem_params
, mem_param_t
*mem_params
,
393 int num_reg_params
, reg_param_t
*reg_param
,
394 u32 entry_point
, u32 exit_point
,
395 int timeout_ms
, void *arch_info
);
398 * Read @count items of @a size bytes from the memory of @a target at
399 * the @a address given.
401 * This routine is a wrapper for target->type->read_memory.
403 extern int target_read_memory(struct target_s
*target
,
404 u32 address
, u32 size
, u32 count
, u8
*buffer
);
406 * Write @count items of @a size bytes to the memory of @a target at
407 * the @a address given.
409 * This routine is wrapper for target->type->write_memory.
411 extern int target_write_memory(struct target_s
*target
,
412 u32 address
, u32 size
, u32 count
, u8
*buffer
);
414 extern int target_write_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
415 extern int target_read_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
416 extern int target_checksum_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* crc
);
417 extern int target_blank_check_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* blank
);
418 extern int target_wait_state(target_t
*target
, enum target_state state
, int ms
);
422 * if "area" passed in to target_alloc_working_area() points to a memory
423 * location that goes out of scope (e.g. a pointer on the stack), then
424 * the caller of target_alloc_working_area() is responsible for invoking
425 * target_free_working_area() before "area" goes out of scope.
427 * target_free_all_working_areas() will NULL out the "area" pointer
428 * upon resuming or resetting the CPU.
431 extern int target_alloc_working_area(struct target_s
*target
, u32 size
, working_area_t
**area
);
432 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
433 extern int target_free_working_area_restore(struct target_s
*target
, working_area_t
*area
, int restore
);
434 extern void target_free_all_working_areas(struct target_s
*target
);
435 extern void target_free_all_working_areas_restore(struct target_s
*target
, int restore
);
437 extern target_t
*all_targets
;
439 extern target_event_callback_t
*target_event_callbacks
;
440 extern target_timer_callback_t
*target_timer_callbacks
;
442 extern u32
target_buffer_get_u32(target_t
*target
, const u8
*buffer
);
443 extern u16
target_buffer_get_u16(target_t
*target
, const u8
*buffer
);
444 extern u8
target_buffer_get_u8 (target_t
*target
, const u8
*buffer
);
445 extern void target_buffer_set_u32(target_t
*target
, u8
*buffer
, u32 value
);
446 extern void target_buffer_set_u16(target_t
*target
, u8
*buffer
, u16 value
);
447 extern void target_buffer_set_u8 (target_t
*target
, u8
*buffer
, u8 value
);
449 int target_read_u32(struct target_s
*target
, u32 address
, u32
*value
);
450 int target_read_u16(struct target_s
*target
, u32 address
, u16
*value
);
451 int target_read_u8(struct target_s
*target
, u32 address
, u8
*value
);
452 int target_write_u32(struct target_s
*target
, u32 address
, u32 value
);
453 int target_write_u16(struct target_s
*target
, u32 address
, u16 value
);
454 int target_write_u8(struct target_s
*target
, u32 address
, u8 value
);
456 /* Issues USER() statements with target state information */
457 int target_arch_state(struct target_s
*target
);
459 void target_handle_event( target_t
*t
, enum target_event e
);
460 void target_all_handle_event( enum target_event e
);
462 #define ERROR_TARGET_INVALID (-300)
463 #define ERROR_TARGET_INIT_FAILED (-301)
464 #define ERROR_TARGET_TIMEOUT (-302)
465 #define ERROR_TARGET_NOT_HALTED (-304)
466 #define ERROR_TARGET_FAILURE (-305)
467 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
468 #define ERROR_TARGET_DATA_ABORT (-307)
469 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
470 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
471 #define ERROR_TARGET_NOT_RUNNING (-310)
472 #define ERROR_TARGET_NOT_EXAMINED (-311)
474 extern const Jim_Nvp nvp_error_target
[];
475 extern const char *target_strerror_safe( int err
);
477 #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)