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 const Jim_Nvp nvp_target_state
[];
65 extern const Jim_Nvp nvp_assert
[];
67 enum target_reset_mode
70 RESET_RUN
= 1, /* reset and let target run */
71 RESET_HALT
= 2, /* reset and halt target out of reset */
72 RESET_INIT
= 3, /* reset and halt target out of reset, then run init script */
75 extern const Jim_Nvp nvp_reset_mode
[];
77 enum target_debug_reason
80 DBG_REASON_BREAKPOINT
= 1,
81 DBG_REASON_WATCHPOINT
= 2,
82 DBG_REASON_WPTANDBKPT
= 3,
83 DBG_REASON_SINGLESTEP
= 4,
84 DBG_REASON_NOTHALTED
= 5,
85 DBG_REASON_UNDEFINED
= 6
88 extern const Jim_Nvp nvp_target_debug_reason
[];
92 TARGET_ENDIAN_UNKNOWN
=0,
93 TARGET_BIG_ENDIAN
= 1, TARGET_LITTLE_ENDIAN
= 2
96 extern const Jim_Nvp nvp_target_endian
[];
100 typedef struct working_area_s
106 struct working_area_s
**user
;
107 struct working_area_s
*next
;
110 typedef struct target_type_s
116 /* poll current target status */
117 int (*poll
)(struct target_s
*target
);
118 /* Invoked only from target_arch_state().
119 * Issue USER() w/architecture specific status. */
120 int (*arch_state
)(struct target_s
*target
);
122 /* target request support */
123 int (*target_request_data
)(struct target_s
*target
, u32 size
, u8
*buffer
);
125 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
126 int (*halt
)(struct target_s
*target
);
127 int (*resume
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
128 int (*step
)(struct target_s
*target
, int current
, u32 address
, int handle_breakpoints
);
130 /* target reset control. assert reset can be invoked when OpenOCD and
131 * the target is out of sync.
133 * A typical example is that the target was power cycled while OpenOCD
134 * thought the target was halted or running.
136 * assert_reset() can therefore make no assumptions whatsoever about the
137 * state of the target
139 * Before assert_reset() for the target is invoked, a TRST/tms and
140 * chain validation is executed. TRST should not be asserted
141 * during target assert unless there is no way around it due to
142 * the way reset's are configured.
145 int (*assert_reset
)(struct target_s
*target
);
146 int (*deassert_reset
)(struct target_s
*target
);
147 int (*soft_reset_halt_imp
)(struct target_s
*target
);
148 int (*soft_reset_halt
)(struct target_s
*target
);
150 /* target register access for gdb.
152 * Danger! this function will succeed even if the target is running
153 * and return a register list with dummy values.
155 * The reason is that GDB connection will fail without a valid register
156 * list, however it is after GDB is connected that monitor commands can
157 * be run to properly initialize the target
159 int (*get_gdb_reg_list
)(struct target_s
*target
, struct reg_s
**reg_list
[], int *reg_list_size
);
161 /* target memory access
162 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
163 * count: number of items of <size>
165 int (*read_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
166 int (*read_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
167 int (*write_memory_imp
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
168 int (*write_memory
)(struct target_s
*target
, u32 address
, u32 size
, u32 count
, u8
*buffer
);
170 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
171 int (*bulk_write_memory
)(struct target_s
*target
, u32 address
, u32 count
, u8
*buffer
);
173 int (*checksum_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* checksum
);
174 int (*blank_check_memory
)(struct target_s
*target
, u32 address
, u32 count
, u32
* blank
);
177 * target break-/watchpoint control
178 * rw: 0 = write, 1 = read, 2 = access
180 * Target must be halted while this is invoked as this
181 * will actually set up breakpoints on target.
183 * The breakpoint hardware will be set up upon adding the first breakpoint.
185 * Upon GDB connection all breakpoints/watchpoints are cleared.
187 int (*add_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
189 /* remove breakpoint. hw will only be updated if the target is currently halted.
190 * However, this method can be invoked on unresponsive targets.
192 int (*remove_breakpoint
)(struct target_s
*target
, breakpoint_t
*breakpoint
);
193 int (*add_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
194 /* remove watchpoint. hw will only be updated if the target is currently halted.
195 * However, this method can be invoked on unresponsive targets.
197 int (*remove_watchpoint
)(struct target_s
*target
, watchpoint_t
*watchpoint
);
199 /* target algorithm support */
200 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
);
201 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
);
203 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
204 /* called when target is created */
205 int (*target_jim_create
)( struct target_s
*target
, Jim_Interp
*interp
);
207 /* called for various config parameters */
208 /* returns JIM_CONTINUE - if option not understood */
209 /* otherwise: JIM_OK, or JIM_ERR, */
210 int (*target_jim_configure
)( struct target_s
*target
, Jim_GetOptInfo
*goi
);
212 /* target commands specifically handled by the target */
213 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
214 int (*target_jim_commands
)( struct target_s
*target
, Jim_GetOptInfo
*goi
);
216 /* old init function */
217 int (*target_command
)(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
, struct target_s
*target
);
218 /* invoked after JTAG chain has been examined & validated. During
219 * this stage the target is examined and any additional setup is
222 * invoked every time after the jtag chain has been validated/examined
224 int (*examine
)(struct target_s
*target
);
225 /* Set up structures for target.
227 * It is illegal to talk to the target at this stage as this fn is invoked
228 * before the JTAG chain has been examined/verified
230 int (*init_target
)(struct command_context_s
*cmd_ctx
, struct target_s
*target
);
233 int (*virt2phys
)(struct target_s
*target
, u32 address
, u32
*physical
);
234 int (*mmu
)(struct target_s
*target
, int *enabled
);
238 // forward decloration
239 typedef struct target_event_action_s target_event_action_t
;
241 typedef struct target_s
243 target_type_t
*type
; /* target type definition (name, access functions) */
244 const char *cmd_name
; /* tcl Name of target */
245 int target_number
; /* generaly, target index but may not be in order */
246 int chain_position
; /* where on the jtag chain is this */
247 const char *variant
; /* what varient of this chip is it? */
248 enum target_reset_mode reset_mode
; /* how should this target be reset */
249 target_event_action_t
*event_action
;
251 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
252 u32 working_area
; /* working area (initialized RAM). Evaluated
253 upon first allocation from virtual/physical address. */
254 u32 working_area_virt
; /* virtual address */
255 u32 working_area_phys
; /* physical address */
256 u32 working_area_size
; /* size in bytes */
257 u32 backup_working_area
; /* whether the content of the working area has to be preserved */
258 struct working_area_s
*working_areas
;/* list of allocated working areas */
259 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
260 enum target_endianess endianness
; /* target endianess */
261 enum target_state state
; /* the current backend-state (running, halted, ...) */
262 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
263 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
264 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
265 struct trace_s
*trace_info
; /* generic trace information */
266 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
267 u32 dbg_msg_enabled
; /* debug message status */
268 void *arch_info
; /* architecture specific information */
269 struct target_s
*next
; /* next target in list */
274 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
275 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
276 TARGET_EVENT_RESUME_START
,
277 TARGET_EVENT_RESUME_END
,
279 TARGET_EVENT_RESET_START
,
280 TARGET_EVENT_RESET
, /* target entered reset */
281 TARGET_EVENT_RESET_INIT
,
282 TARGET_EVENT_RESET_END
,
284 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
285 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
287 TARGET_EVENT_GDB_ATTACH
,
288 TARGET_EVENT_GDB_DETACH
,
290 TARGET_EVENT_GDB_FLASH_ERASE_START
,
291 TARGET_EVENT_GDB_FLASH_ERASE_END
,
292 TARGET_EVENT_GDB_FLASH_WRITE_START
,
293 TARGET_EVENT_GDB_FLASH_WRITE_END
,
296 extern const Jim_Nvp nvp_target_event
[];
298 struct target_event_action_s
{
299 enum target_event event
;
301 target_event_action_t
*next
;
304 typedef struct target_event_callback_s
306 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
308 struct target_event_callback_s
*next
;
309 } target_event_callback_t
;
311 typedef struct target_timer_callback_s
313 int (*callback
)(void *priv
);
318 struct target_timer_callback_s
*next
;
319 } target_timer_callback_t
;
321 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
322 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
323 extern int target_init(struct command_context_s
*cmd_ctx
);
324 extern int target_examine(void);
325 extern int handle_target(void *priv
);
326 extern int target_process_reset(struct command_context_s
*cmd_ctx
, enum target_reset_mode reset_mode
);
328 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
329 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
330 extern int target_poll(target_t
*target
);
331 extern int target_resume(target_t
*target
, int current
, u32 address
, int handle_breakpoints
, int debug_execution
);
332 extern int target_halt(target_t
*target
);
333 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
335 /* The period is very approximate, the callback can happen much more often
336 * or much more rarely than specified
338 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
339 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
340 extern int target_call_timer_callbacks(void);
341 /* invoke this to ensure that e.g. polling timer callbacks happen before
342 * a syncrhonous command completes.
344 extern int target_call_timer_callbacks_now(void);
346 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
347 extern int get_num_by_target(target_t
*query_target
);
348 extern target_t
* get_target_by_num(int num
);
350 extern int target_write_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
351 extern int target_read_buffer(struct target_s
*target
, u32 address
, u32 size
, u8
*buffer
);
352 extern int target_checksum_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* crc
);
353 extern int target_blank_check_memory(struct target_s
*target
, u32 address
, u32 size
, u32
* blank
);
354 extern int target_wait_state(target_t
*target
, enum target_state state
, int ms
);
358 * if "area" passed in to target_alloc_working_area() points to a memory
359 * location that goes out of scope (e.g. a pointer on the stack), then
360 * the caller of target_alloc_working_area() is responsible for invoking
361 * target_free_working_area() before "area" goes out of scope.
363 * target_free_all_working_areas() will NULL out the "area" pointer
364 * upon resuming or resetting the CPU.
367 extern int target_alloc_working_area(struct target_s
*target
, u32 size
, working_area_t
**area
);
368 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
369 extern int target_free_working_area_restore(struct target_s
*target
, working_area_t
*area
, int restore
);
370 extern int target_free_all_working_areas(struct target_s
*target
);
371 extern int target_free_all_working_areas_restore(struct target_s
*target
, int restore
);
373 extern target_t
*all_targets
;
375 extern target_event_callback_t
*target_event_callbacks
;
376 extern target_timer_callback_t
*target_timer_callbacks
;
378 extern u32
target_buffer_get_u32(target_t
*target
, u8
*buffer
);
379 extern u16
target_buffer_get_u16(target_t
*target
, u8
*buffer
);
380 extern u8
target_buffer_get_u8 (target_t
*target
, u8
*buffer
);
381 extern void target_buffer_set_u32(target_t
*target
, u8
*buffer
, u32 value
);
382 extern void target_buffer_set_u16(target_t
*target
, u8
*buffer
, u16 value
);
383 extern void target_buffer_set_u8 (target_t
*target
, u8
*buffer
, u8 value
);
385 int target_read_u32(struct target_s
*target
, u32 address
, u32
*value
);
386 int target_read_u16(struct target_s
*target
, u32 address
, u16
*value
);
387 int target_read_u8(struct target_s
*target
, u32 address
, u8
*value
);
388 int target_write_u32(struct target_s
*target
, u32 address
, u32 value
);
389 int target_write_u16(struct target_s
*target
, u32 address
, u16 value
);
390 int target_write_u8(struct target_s
*target
, u32 address
, u8 value
);
392 /* Issues USER() statements with target state information */
393 int target_arch_state(struct target_s
*target
);
395 int target_invoke_script(struct command_context_s
*cmd_ctx
, target_t
*target
, char *name
);
398 #define ERROR_TARGET_INVALID (-300)
399 #define ERROR_TARGET_INIT_FAILED (-301)
400 #define ERROR_TARGET_TIMEOUT (-302)
401 #define ERROR_TARGET_NOT_HALTED (-304)
402 #define ERROR_TARGET_FAILURE (-305)
403 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
404 #define ERROR_TARGET_DATA_ABORT (-307)
405 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
406 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
407 #define ERROR_TARGET_NOT_RUNNING (-310)
408 #define ERROR_TARGET_NOT_EXAMINED (-311)
410 #endif /* TARGET_H */
414 * Local Variables: ***
415 * c-basic-offset: 4 ***
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)