1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * Copyright (C) 2011 by Broadcom Corporation *
12 * Evan Hunter - ehunter@broadcom.com *
14 * Copyright (C) ST-Ericsson SA 2011 *
15 * michel.jaouen@stericsson.com : smp minimum support *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program; if not, write to the *
29 * Free Software Foundation, Inc., *
30 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
31 ***************************************************************************/
38 struct command_context
;
46 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
47 * TARGET_RUNNING = 1: the target is executing user code
48 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
49 * debugger. on an xscale it means that the debug handler is executing
50 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
51 * not sure how this is used with all the recent changes)
52 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
53 * behalf of the debugger (e.g. algorithm for flashing)
55 * also see: target_state_name();
64 TARGET_DEBUG_RUNNING
= 4,
72 enum target_reset_mode
{
74 RESET_RUN
= 1, /* reset and let target run */
75 RESET_HALT
= 2, /* reset and halt target out of reset */
76 RESET_INIT
= 3, /* reset and halt target out of reset, then run init script */
79 enum target_debug_reason
{
81 DBG_REASON_BREAKPOINT
= 1,
82 DBG_REASON_WATCHPOINT
= 2,
83 DBG_REASON_WPTANDBKPT
= 3,
84 DBG_REASON_SINGLESTEP
= 4,
85 DBG_REASON_NOTHALTED
= 5,
86 DBG_REASON_UNDEFINED
= 6
89 enum target_endianness
{
90 TARGET_ENDIAN_UNKNOWN
= 0,
91 TARGET_BIG_ENDIAN
= 1, TARGET_LITTLE_ENDIAN
= 2
99 struct working_area
**user
;
100 struct working_area
*next
;
104 struct target
*target
;
105 /* field for smp display */
106 /* element 0 coreid currently displayed ( 1 till n) */
107 /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
108 * all cores core displayed */
112 /* target_type.h contains the full definitionof struct targe_type */
114 struct target_type
*type
; /* target type definition (name, access functions) */
115 const char *cmd_name
; /* tcl Name of target */
116 int target_number
; /* DO NOT USE! field to be removed in 2010 */
117 struct jtag_tap
*tap
; /* where on the jtag chain is this */
118 int32_t coreid
; /* which device on the TAP? */
119 const char *variant
; /* what variant of this chip is it? */
122 * Indicates whether this target has been examined.
124 * Do @b not access this field directly, use target_was_examined()
125 * or target_set_examined().
129 /** true iff the target is currently running a downloaded
130 * "algorithm" instetad of arbitrary user code. OpenOCD code
131 * invoking algorithms is trusted to maintain correctness of
132 * any cached state (e.g. for flash status), which arbitrary
133 * code will have no reason to know about.
137 struct target_event_action
*event_action
;
139 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
140 uint32_t working_area
; /* working area (initialized RAM). Evaluated
141 * upon first allocation from virtual/physical address. */
142 bool working_area_virt_spec
; /* virtual address specified? */
143 uint32_t working_area_virt
; /* virtual address */
144 bool working_area_phys_spec
; /* virtual address specified? */
145 uint32_t working_area_phys
; /* physical address */
146 uint32_t working_area_size
; /* size in bytes */
147 uint32_t backup_working_area
; /* whether the content of the working area has to be preserved */
148 struct working_area
*working_areas
;/* list of allocated working areas */
149 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
150 enum target_endianness endianness
; /* target endianness */
151 /* also see: target_state_name() */
152 enum target_state state
; /* the current backend-state (running, halted, ...) */
153 struct reg_cache
*reg_cache
; /* the first register cache of the target (core regs) */
154 struct breakpoint
*breakpoints
; /* list of breakpoints */
155 struct watchpoint
*watchpoints
; /* list of watchpoints */
156 struct trace
*trace_info
; /* generic trace information */
157 struct debug_msg_receiver
*dbgmsg
; /* list of debug message receivers */
158 uint32_t dbg_msg_enabled
; /* debug message status */
159 void *arch_info
; /* architecture specific information */
160 struct target
*next
; /* next target in list */
162 int display
; /* display async info in telnet session. Do not display
163 * lots of halted/resumed info when stepping in debugger. */
164 bool halt_issued
; /* did we transition to halted state? */
165 long long halt_issued_time
; /* Note time when halt was issued */
167 bool dbgbase_set
; /* By default the debug base is not set */
168 uint32_t dbgbase
; /* Really a Cortex-A specific option, but there is no
169 system in place to support target specific options
171 struct rtos
*rtos
; /* Instance of Real Time Operating System support */
172 bool rtos_auto_detect
; /* A flag that indicates that the RTOS has been specified as "auto"
173 * and must be detected when symbols are offered */
175 int smp
; /* add some target attributes for smp support */
176 struct target_list
*head
;
177 /* the gdb service is there in case of smp , we have only one gdb server
179 * the target attached to the gdb is changing dynamically by changing
180 * gdb_service->target pointer */
181 struct gdb_service
*gdb_service
;
185 struct target
*target
;
186 struct target_list
*next
;
189 /** Returns the instance-specific name of the specified target. */
190 static inline const char *target_name(struct target
*target
)
192 return target
->cmd_name
;
195 const char *debug_reason_name(struct target
*t
);
198 /* LD historical names
199 * - Prior to the great TCL change
200 * - June/July/Aug 2008
202 TARGET_EVENT_OLD_gdb_program_config
,
203 TARGET_EVENT_OLD_pre_resume
,
205 /* allow GDB to do stuff before others handle the halted event,
206 * this is in lieu of defining ordering of invocation of events,
207 * which would be more complicated
209 * Telling GDB to halt does not mean that the target stopped running,
210 * simply that we're dropping out of GDB's waiting for step or continue.
212 * This can be useful when e.g. detecting power dropout.
214 TARGET_EVENT_GDB_HALT
,
215 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
216 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
217 TARGET_EVENT_RESUME_START
,
218 TARGET_EVENT_RESUME_END
,
220 TARGET_EVENT_GDB_START
, /* debugger started execution (step/run) */
221 TARGET_EVENT_GDB_END
, /* debugger stopped execution (step/run) */
223 TARGET_EVENT_RESET_START
,
224 TARGET_EVENT_RESET_ASSERT_PRE
,
225 TARGET_EVENT_RESET_ASSERT
, /* C code uses this instead of SRST */
226 TARGET_EVENT_RESET_ASSERT_POST
,
227 TARGET_EVENT_RESET_DEASSERT_PRE
,
228 TARGET_EVENT_RESET_DEASSERT_POST
,
229 TARGET_EVENT_RESET_HALT_PRE
,
230 TARGET_EVENT_RESET_HALT_POST
,
231 TARGET_EVENT_RESET_WAIT_PRE
,
232 TARGET_EVENT_RESET_WAIT_POST
,
233 TARGET_EVENT_RESET_INIT
,
234 TARGET_EVENT_RESET_END
,
236 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
237 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
239 TARGET_EVENT_EXAMINE_START
,
240 TARGET_EVENT_EXAMINE_END
,
242 TARGET_EVENT_GDB_ATTACH
,
243 TARGET_EVENT_GDB_DETACH
,
245 TARGET_EVENT_GDB_FLASH_ERASE_START
,
246 TARGET_EVENT_GDB_FLASH_ERASE_END
,
247 TARGET_EVENT_GDB_FLASH_WRITE_START
,
248 TARGET_EVENT_GDB_FLASH_WRITE_END
,
251 struct target_event_action
{
252 enum target_event event
;
253 struct Jim_Interp
*interp
;
254 struct Jim_Obj
*body
;
256 struct target_event_action
*next
;
259 bool target_has_event_action(struct target
*target
, enum target_event event
);
261 struct target_event_callback
{
262 int (*callback
)(struct target
*target
, enum target_event event
, void *priv
);
264 struct target_event_callback
*next
;
267 struct target_timer_callback
{
268 int (*callback
)(void *priv
);
273 struct target_timer_callback
*next
;
276 int target_register_commands(struct command_context
*cmd_ctx
);
277 int target_examine(void);
279 int target_register_event_callback(
280 int (*callback
)(struct target
*target
,
281 enum target_event event
, void *priv
),
283 int target_unregister_event_callback(
284 int (*callback
)(struct target
*target
,
285 enum target_event event
, void *priv
),
287 /* Poll the status of the target, detect any error conditions and report them.
289 * Also note that this fn will clear such error conditions, so a subsequent
290 * invocation will then succeed.
292 * These error conditions can be "sticky" error conditions. E.g. writing
293 * to memory could be implemented as an open loop and if memory writes
294 * fails, then a note is made of it, the error is sticky, but the memory
295 * write loop still runs to completion. This improves performance in the
296 * normal case as there is no need to verify that every single write succeed,
297 * yet it is possible to detect error condtions.
299 int target_poll(struct target
*target
);
300 int target_resume(struct target
*target
, int current
, uint32_t address
,
301 int handle_breakpoints
, int debug_execution
);
302 int target_halt(struct target
*target
);
303 int target_call_event_callbacks(struct target
*target
, enum target_event event
);
306 * The period is very approximate, the callback can happen much more often
307 * or much more rarely than specified
309 int target_register_timer_callback(int (*callback
)(void *priv
),
310 int time_ms
, int periodic
, void *priv
);
312 int target_call_timer_callbacks(void);
314 * Invoke this to ensure that e.g. polling timer callbacks happen before
315 * a syncrhonous command completes.
317 int target_call_timer_callbacks_now(void);
319 struct target
*get_current_target(struct command_context
*cmd_ctx
);
320 struct target
*get_target(const char *id
);
323 * Get the target type name.
325 * This routine is a wrapper for the target->type->name field.
326 * Note that this is not an instance-specific name for his target.
328 const char *target_type_name(struct target
*target
);
331 * Examine the specified @a target, letting it perform any
332 * initialization that requires JTAG access.
334 * This routine is a wrapper for target->type->examine.
336 int target_examine_one(struct target
*target
);
338 /** @returns @c true if target_set_examined() has been called. */
339 static inline bool target_was_examined(struct target
*target
)
341 return target
->examined
;
344 /** Sets the @c examined flag for the given target. */
345 /** Use in target->type->examine() after one-time setup is done. */
346 static inline void target_set_examined(struct target
*target
)
348 target
->examined
= true;
352 * Add the @a breakpoint for @a target.
354 * This routine is a wrapper for target->type->add_breakpoint.
356 int target_add_breakpoint(struct target
*target
,
357 struct breakpoint
*breakpoint
);
359 * Add the @a ContextID breakpoint for @a target.
361 * This routine is a wrapper for target->type->add_context_breakpoint.
363 int target_add_context_breakpoint(struct target
*target
,
364 struct breakpoint
*breakpoint
);
366 * Add the @a ContextID & IVA breakpoint for @a target.
368 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
370 int target_add_hybrid_breakpoint(struct target
*target
,
371 struct breakpoint
*breakpoint
);
373 * Remove the @a breakpoint for @a target.
375 * This routine is a wrapper for target->type->remove_breakpoint.
378 int target_remove_breakpoint(struct target
*target
,
379 struct breakpoint
*breakpoint
);
381 * Add the @a watchpoint for @a target.
383 * This routine is a wrapper for target->type->add_watchpoint.
385 int target_add_watchpoint(struct target
*target
,
386 struct watchpoint
*watchpoint
);
388 * Remove the @a watchpoint for @a target.
390 * This routine is a wrapper for target->type->remove_watchpoint.
392 int target_remove_watchpoint(struct target
*target
,
393 struct watchpoint
*watchpoint
);
396 * Obtain the registers for GDB.
398 * This routine is a wrapper for target->type->get_gdb_reg_list.
400 int target_get_gdb_reg_list(struct target
*target
,
401 struct reg
**reg_list
[], int *reg_list_size
);
406 * This routine is a wrapper for target->type->step.
408 int target_step(struct target
*target
,
409 int current
, uint32_t address
, int handle_breakpoints
);
411 * Run an algorithm on the @a target given.
413 * This routine is a wrapper for target->type->run_algorithm.
415 int target_run_algorithm(struct target
*target
,
416 int num_mem_params
, struct mem_param
*mem_params
,
417 int num_reg_params
, struct reg_param
*reg_param
,
418 uint32_t entry_point
, uint32_t exit_point
,
419 int timeout_ms
, void *arch_info
);
422 * Starts an algorithm in the background on the @a target given.
424 * This routine is a wrapper for target->type->start_algorithm.
426 int target_start_algorithm(struct target
*target
,
427 int num_mem_params
, struct mem_param
*mem_params
,
428 int num_reg_params
, struct reg_param
*reg_params
,
429 uint32_t entry_point
, uint32_t exit_point
,
433 * Wait for an algorithm on the @a target given.
435 * This routine is a wrapper for target->type->wait_algorithm.
437 int target_wait_algorithm(struct target
*target
,
438 int num_mem_params
, struct mem_param
*mem_params
,
439 int num_reg_params
, struct reg_param
*reg_params
,
440 uint32_t exit_point
, int timeout_ms
,
444 * This routine is a wrapper for asynchronous algorithms.
447 int target_run_flash_async_algorithm(struct target
*target
,
448 uint8_t *buffer
, uint32_t count
, int block_size
,
449 int num_mem_params
, struct mem_param
*mem_params
,
450 int num_reg_params
, struct reg_param
*reg_params
,
451 uint32_t buffer_start
, uint32_t buffer_size
,
452 uint32_t entry_point
, uint32_t exit_point
,
456 * Read @a count items of @a size bytes from the memory of @a target at
457 * the @a address given.
459 * This routine is a wrapper for target->type->read_memory.
461 int target_read_memory(struct target
*target
,
462 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
464 * Write @a count items of @a size bytes to the memory of @a target at
465 * the @a address given. @a address must be aligned to @a size
468 * The endianness is the same in the host and target memory for this
472 * Really @a buffer should have been defined as "const void *" and
473 * @a buffer should have been aligned to @a size in the host memory.
475 * This is not enforced via e.g. assert's today and e.g. the
476 * target_write_buffer fn breaks this assumption.
478 * This routine is wrapper for target->type->write_memory.
480 int target_write_memory(struct target
*target
,
481 uint32_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
);
484 * Write @a count items of 4 bytes to the memory of @a target at
485 * the @a address given. Because it operates only on whole words,
486 * this should be faster than target_write_memory().
488 * This routine is wrapper for target->type->bulk_write_memory.
490 int target_bulk_write_memory(struct target
*target
,
491 uint32_t address
, uint32_t count
, const uint8_t *buffer
);
494 * Write to target memory using the virtual address.
496 * Note that this fn is used to implement software breakpoints. Targets
497 * can implement support for software breakpoints to memory marked as read
498 * only by making this fn write to ram even if it is read only(MMU or
501 * It is sufficient to implement for writing a single word(16 or 32 in
502 * ARM32/16 bit case) to write the breakpoint to ram.
504 * The target should also take care of "other things" to make sure that
505 * software breakpoints can be written using this function. E.g.
506 * when there is a separate instruction and data cache, this fn must
507 * make sure that the instruction cache is synced up to the potential
508 * code change that can happen as a result of the memory write(typically
509 * by invalidating the cache).
511 * The high level wrapper fn in target.c will break down this memory write
512 * request to multiple write requests to the target driver to e.g. guarantee
513 * that writing 4 bytes to an aligned address happens with a single 32 bit
514 * write operation, thus making this fn suitable to e.g. write to special
515 * peripheral registers which do not support byte operations.
517 int target_write_buffer(struct target
*target
,
518 uint32_t address
, uint32_t size
, const uint8_t *buffer
);
519 int target_read_buffer(struct target
*target
,
520 uint32_t address
, uint32_t size
, uint8_t *buffer
);
521 int target_checksum_memory(struct target
*target
,
522 uint32_t address
, uint32_t size
, uint32_t *crc
);
523 int target_blank_check_memory(struct target
*target
,
524 uint32_t address
, uint32_t size
, uint32_t *blank
);
525 int target_wait_state(struct target
*target
, enum target_state state
, int ms
);
527 /** Return the *name* of this targets current state */
528 const char *target_state_name(struct target
*target
);
532 * if "area" passed in to target_alloc_working_area() points to a memory
533 * location that goes out of scope (e.g. a pointer on the stack), then
534 * the caller of target_alloc_working_area() is responsible for invoking
535 * target_free_working_area() before "area" goes out of scope.
537 * target_free_all_working_areas() will NULL out the "area" pointer
538 * upon resuming or resetting the CPU.
541 int target_alloc_working_area(struct target
*target
,
542 uint32_t size
, struct working_area
**area
);
543 /* Same as target_alloc_working_area, except that no error is logged
544 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
546 * This allows the calling code to *try* to allocate target memory
547 * and have a fallback to another behavior(slower?).
549 int target_alloc_working_area_try(struct target
*target
,
550 uint32_t size
, struct working_area
**area
);
551 int target_free_working_area(struct target
*target
, struct working_area
*area
);
552 void target_free_all_working_areas(struct target
*target
);
553 uint32_t target_get_working_area_avail(struct target
*target
);
555 extern struct target
*all_targets
;
557 uint32_t target_buffer_get_u32(struct target
*target
, const uint8_t *buffer
);
558 uint32_t target_buffer_get_u24(struct target
*target
, const uint8_t *buffer
);
559 uint16_t target_buffer_get_u16(struct target
*target
, const uint8_t *buffer
);
560 void target_buffer_set_u32(struct target
*target
, uint8_t *buffer
, uint32_t value
);
561 void target_buffer_set_u24(struct target
*target
, uint8_t *buffer
, uint32_t value
);
562 void target_buffer_set_u16(struct target
*target
, uint8_t *buffer
, uint16_t value
);
564 void target_buffer_get_u32_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint32_t *dstbuf
);
565 void target_buffer_get_u16_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint16_t *dstbuf
);
566 void target_buffer_set_u32_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, uint32_t *srcbuf
);
567 void target_buffer_set_u16_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, uint16_t *srcbuf
);
569 int target_read_u32(struct target
*target
, uint32_t address
, uint32_t *value
);
570 int target_read_u16(struct target
*target
, uint32_t address
, uint16_t *value
);
571 int target_read_u8(struct target
*target
, uint32_t address
, uint8_t *value
);
572 int target_write_u32(struct target
*target
, uint32_t address
, uint32_t value
);
573 int target_write_u16(struct target
*target
, uint32_t address
, uint16_t value
);
574 int target_write_u8(struct target
*target
, uint32_t address
, uint8_t value
);
576 /* Issues USER() statements with target state information */
577 int target_arch_state(struct target
*target
);
579 void target_handle_event(struct target
*t
, enum target_event e
);
581 #define ERROR_TARGET_INVALID (-300)
582 #define ERROR_TARGET_INIT_FAILED (-301)
583 #define ERROR_TARGET_TIMEOUT (-302)
584 #define ERROR_TARGET_NOT_HALTED (-304)
585 #define ERROR_TARGET_FAILURE (-305)
586 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
587 #define ERROR_TARGET_DATA_ABORT (-307)
588 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
589 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
590 #define ERROR_TARGET_NOT_RUNNING (-310)
591 #define ERROR_TARGET_NOT_EXAMINED (-311)
593 extern bool get_target_reset_nag(void);
595 #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)