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)
47 * also see: target_state_name();
57 TARGET_DEBUG_RUNNING
= 4,
60 extern const Jim_Nvp nvp_target_state
[];
67 extern const Jim_Nvp nvp_assert
[];
69 enum target_reset_mode
72 RESET_RUN
= 1, /* reset and let target run */
73 RESET_HALT
= 2, /* reset and halt target out of reset */
74 RESET_INIT
= 3, /* reset and halt target out of reset, then run init script */
77 extern const Jim_Nvp nvp_reset_mode
[];
79 enum target_debug_reason
82 DBG_REASON_BREAKPOINT
= 1,
83 DBG_REASON_WATCHPOINT
= 2,
84 DBG_REASON_WPTANDBKPT
= 3,
85 DBG_REASON_SINGLESTEP
= 4,
86 DBG_REASON_NOTHALTED
= 5,
87 DBG_REASON_UNDEFINED
= 6
90 extern const Jim_Nvp nvp_target_debug_reason
[];
94 TARGET_ENDIAN_UNKNOWN
= 0,
95 TARGET_BIG_ENDIAN
= 1, TARGET_LITTLE_ENDIAN
= 2
98 extern const Jim_Nvp nvp_target_endian
[];
102 typedef struct working_area_s
108 struct working_area_s
**user
;
109 struct working_area_s
*next
;
112 // target_type.h contains the full definitionof struct target_type_s
113 struct target_type_s
;
114 typedef struct target_type_s target_type_t
;
116 /* forward decloration */
117 typedef struct target_event_action_s target_event_action_t
;
119 typedef struct target_s
121 target_type_t
*type
; /* target type definition (name, access functions) */
122 const char *cmd_name
; /* tcl Name of target */
123 int target_number
; /* DO NOT USE! field to be removed in 2010 */
124 jtag_tap_t
*tap
; /* where on the jtag chain is this */
125 const char *variant
; /* what varient of this chip is it? */
126 target_event_action_t
*event_action
;
128 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
129 uint32_t working_area
; /* working area (initialized RAM). Evaluated
130 * upon first allocation from virtual/physical address. */
131 uint32_t working_area_virt
; /* virtual address */
132 uint32_t working_area_phys
; /* physical address */
133 uint32_t working_area_size
; /* size in bytes */
134 uint32_t backup_working_area
; /* whether the content of the working area has to be preserved */
135 struct working_area_s
*working_areas
;/* list of allocated working areas */
136 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
137 enum target_endianess endianness
; /* target endianess */
138 // also see: target_state_name()
139 enum target_state state
; /* the current backend-state (running, halted, ...) */
140 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
141 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
142 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
143 struct trace_s
*trace_info
; /* generic trace information */
144 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
145 uint32_t dbg_msg_enabled
; /* debug message status */
146 void *arch_info
; /* architecture specific information */
147 struct target_s
*next
; /* next target in list */
149 int display
; /* display async info in telnet session. Do not display
150 * lots of halted/resumed info when stepping in debugger. */
155 /* LD historical names
156 * - Prior to the great TCL change
157 * - June/July/Aug 2008
159 TARGET_EVENT_OLD_gdb_program_config
,
160 TARGET_EVENT_OLD_pre_reset
,
161 TARGET_EVENT_OLD_post_reset
,
162 TARGET_EVENT_OLD_pre_resume
,
164 /* allow GDB to do stuff before others handle the halted event,
165 * this is in lieu of defining ordering of invocation of events,
166 * which would be more complicated */
167 TARGET_EVENT_EARLY_HALTED
,
168 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
169 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
170 TARGET_EVENT_RESUME_START
,
171 TARGET_EVENT_RESUME_END
,
173 TARGET_EVENT_GDB_START
, /* debugger started execution (step/run) */
174 TARGET_EVENT_GDB_END
, /* debugger stopped execution (step/run) */
176 TARGET_EVENT_RESET_START
,
177 TARGET_EVENT_RESET_ASSERT_PRE
,
178 TARGET_EVENT_RESET_ASSERT_POST
,
179 TARGET_EVENT_RESET_DEASSERT_PRE
,
180 TARGET_EVENT_RESET_DEASSERT_POST
,
181 TARGET_EVENT_RESET_HALT_PRE
,
182 TARGET_EVENT_RESET_HALT_POST
,
183 TARGET_EVENT_RESET_WAIT_PRE
,
184 TARGET_EVENT_RESET_WAIT_POST
,
185 TARGET_EVENT_RESET_INIT
,
186 TARGET_EVENT_RESET_END
,
188 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
189 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
191 TARGET_EVENT_EXAMINE_START
,
192 TARGET_EVENT_EXAMINE_END
,
194 TARGET_EVENT_GDB_ATTACH
,
195 TARGET_EVENT_GDB_DETACH
,
197 TARGET_EVENT_GDB_FLASH_ERASE_START
,
198 TARGET_EVENT_GDB_FLASH_ERASE_END
,
199 TARGET_EVENT_GDB_FLASH_WRITE_START
,
200 TARGET_EVENT_GDB_FLASH_WRITE_END
,
203 struct target_event_action_s
{
204 enum target_event event
;
207 target_event_action_t
*next
;
210 typedef struct target_event_callback_s
212 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
214 struct target_event_callback_s
*next
;
215 } target_event_callback_t
;
217 typedef struct target_timer_callback_s
219 int (*callback
)(void *priv
);
224 struct target_timer_callback_s
*next
;
225 } target_timer_callback_t
;
227 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
228 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
229 extern int target_init(struct command_context_s
*cmd_ctx
);
230 extern int target_examine(void);
231 extern int handle_target(void *priv
);
232 extern int target_process_reset(struct command_context_s
*cmd_ctx
, enum target_reset_mode reset_mode
);
234 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
235 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
236 extern int target_poll(target_t
*target
);
237 extern int target_resume(target_t
*target
, int current
, uint32_t address
, int handle_breakpoints
, int debug_execution
);
238 extern int target_halt(target_t
*target
);
239 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
241 /* The period is very approximate, the callback can happen much more often
242 * or much more rarely than specified
244 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
245 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
246 extern int target_call_timer_callbacks(void);
247 /* invoke this to ensure that e.g. polling timer callbacks happen before
248 * a syncrhonous command completes.
250 extern int target_call_timer_callbacks_now(void);
252 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
253 extern target_t
*get_target(const char *id
);
256 * Get the target name.
258 * This routine is a wrapper for the target->type->name field.
260 extern const char *target_get_name(struct target_s
*target
);
263 * Examine the specified @a target.
265 * This routine is a wrapper for target->type->examine.
267 extern int target_examine_one(struct target_s
*target
);
268 /// @returns @c true if the target has been examined.
269 extern bool target_was_examined(struct target_s
*target
);
270 /// Sets the @c examined flag for the given target.
271 extern void target_set_examined(struct target_s
*target
);
272 /// Reset the @c examined flag for the given target.
273 extern void target_reset_examined(struct target_s
*target
);
277 * Add the @a breakpoint for @a target.
279 * This routine is a wrapper for target->type->add_breakpoint.
281 extern int target_add_breakpoint(struct target_s
*target
,
282 struct breakpoint_s
*breakpoint
);
284 * Remove the @a breakpoint for @a target.
286 * This routine is a wrapper for target->type->remove_breakpoint.
288 extern int target_remove_breakpoint(struct target_s
*target
,
289 struct breakpoint_s
*breakpoint
);
291 * Add the @a watchpoint for @a target.
293 * This routine is a wrapper for target->type->add_watchpoint.
295 extern int target_add_watchpoint(struct target_s
*target
,
296 struct watchpoint_s
*watchpoint
);
298 * Remove the @a watchpoint for @a target.
300 * This routine is a wrapper for target->type->remove_watchpoint.
302 extern int target_remove_watchpoint(struct target_s
*target
,
303 struct watchpoint_s
*watchpoint
);
306 * Obtain the registers for GDB.
308 * This routine is a wrapper for target->type->get_gdb_reg_list.
310 extern int target_get_gdb_reg_list(struct target_s
*target
,
311 struct reg_s
**reg_list
[], int *reg_list_size
);
316 * This routine is a wrapper for target->type->step.
318 int target_step(struct target_s
*target
,
319 int current
, uint32_t address
, int handle_breakpoints
);
321 * Run an algorithm on the @a target given.
323 * This routine is a wrapper for target->type->run_algorithm.
325 extern int target_run_algorithm(struct target_s
*target
,
326 int num_mem_params
, mem_param_t
*mem_params
,
327 int num_reg_params
, reg_param_t
*reg_param
,
328 uint32_t entry_point
, uint32_t exit_point
,
329 int timeout_ms
, void *arch_info
);
332 * Read @a count items of @a size bytes from the memory of @a target at
333 * the @a address given.
335 * This routine is a wrapper for target->type->read_memory.
337 extern int target_read_memory(struct target_s
*target
,
338 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
340 * Write @a count items of @a size bytes to the memory of @a target at
341 * the @a address given.
343 * This routine is wrapper for target->type->write_memory.
345 extern int target_write_memory(struct target_s
*target
,
346 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
349 * Write @a count items of 4 bytes to the memory of @a target at
350 * the @a address given. Because it operates only on whole words,
351 * this should be faster than target_write_memory().
353 * This routine is wrapper for target->type->bulk_write_memory.
355 extern int target_bulk_write_memory(struct target_s
*target
,
356 uint32_t address
, uint32_t count
, uint8_t *buffer
);
358 extern int target_write_buffer(struct target_s
*target
, uint32_t address
, uint32_t size
, uint8_t *buffer
);
359 extern int target_read_buffer(struct target_s
*target
, uint32_t address
, uint32_t size
, uint8_t *buffer
);
360 extern int target_checksum_memory(struct target_s
*target
, uint32_t address
, uint32_t size
, uint32_t* crc
);
361 extern int target_blank_check_memory(struct target_s
*target
, uint32_t address
, uint32_t size
, uint32_t* blank
);
362 extern int target_wait_state(target_t
*target
, enum target_state state
, int ms
);
364 /** Return the *name* of this targets current state */
365 const char *target_state_name( target_t
*target
);
369 * if "area" passed in to target_alloc_working_area() points to a memory
370 * location that goes out of scope (e.g. a pointer on the stack), then
371 * the caller of target_alloc_working_area() is responsible for invoking
372 * target_free_working_area() before "area" goes out of scope.
374 * target_free_all_working_areas() will NULL out the "area" pointer
375 * upon resuming or resetting the CPU.
378 extern int target_alloc_working_area(struct target_s
*target
, uint32_t size
, working_area_t
**area
);
379 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
380 extern int target_free_working_area_restore(struct target_s
*target
, working_area_t
*area
, int restore
);
381 extern void target_free_all_working_areas(struct target_s
*target
);
382 extern void target_free_all_working_areas_restore(struct target_s
*target
, int restore
);
384 extern target_t
*all_targets
;
386 extern target_event_callback_t
*target_event_callbacks
;
387 extern target_timer_callback_t
*target_timer_callbacks
;
389 extern uint32_t target_buffer_get_u32(target_t
*target
, const uint8_t *buffer
);
390 extern uint16_t target_buffer_get_u16(target_t
*target
, const uint8_t *buffer
);
391 extern uint8_t target_buffer_get_u8 (target_t
*target
, const uint8_t *buffer
);
392 extern void target_buffer_set_u32(target_t
*target
, uint8_t *buffer
, uint32_t value
);
393 extern void target_buffer_set_u16(target_t
*target
, uint8_t *buffer
, uint16_t value
);
394 extern void target_buffer_set_u8 (target_t
*target
, uint8_t *buffer
, uint8_t value
);
396 int target_read_u32(struct target_s
*target
, uint32_t address
, uint32_t *value
);
397 int target_read_u16(struct target_s
*target
, uint32_t address
, uint16_t *value
);
398 int target_read_u8(struct target_s
*target
, uint32_t address
, uint8_t *value
);
399 int target_write_u32(struct target_s
*target
, uint32_t address
, uint32_t value
);
400 int target_write_u16(struct target_s
*target
, uint32_t address
, uint16_t value
);
401 int target_write_u8(struct target_s
*target
, uint32_t address
, uint8_t value
);
403 /* Issues USER() statements with target state information */
404 int target_arch_state(struct target_s
*target
);
406 void target_handle_event(target_t
*t
, enum target_event e
);
407 void target_all_handle_event(enum target_event e
);
409 #define ERROR_TARGET_INVALID (-300)
410 #define ERROR_TARGET_INIT_FAILED (-301)
411 #define ERROR_TARGET_TIMEOUT (-302)
412 #define ERROR_TARGET_NOT_HALTED (-304)
413 #define ERROR_TARGET_FAILURE (-305)
414 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
415 #define ERROR_TARGET_DATA_ABORT (-307)
416 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
417 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
418 #define ERROR_TARGET_NOT_RUNNING (-310)
419 #define ERROR_TARGET_NOT_EXAMINED (-311)
421 extern const Jim_Nvp nvp_error_target
[];
422 extern const char *target_strerror_safe(int err
);
424 #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)