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, see <http://www.gnu.org/licenses/>. *
29 ***************************************************************************/
31 #ifndef OPENOCD_TARGET_TARGET_H
32 #define OPENOCD_TARGET_TARGET_H
34 #include <helper/list.h>
38 struct command_context;
44 struct gdb_fileio_info;
47 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
48 * TARGET_RUNNING = 1: the target is executing user code
49 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
50 * debugger. on an xscale it means that the debug handler is executing
51 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
52 * not sure how this is used with all the recent changes)
53 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
54 * behalf of the debugger (e.g. algorithm for flashing)
56 * 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,
87 DBG_REASON_UNDEFINED = 7,
90 enum target_endianness {
91 TARGET_ENDIAN_UNKNOWN = 0,
92 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
96 target_addr_t address;
100 struct working_area **user;
101 struct working_area *next;
105 struct target *target;
106 /* field for smp display */
107 /* element 0 coreid currently displayed ( 1 till n) */
108 /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
109 * all cores core displayed */
113 /* target back off timer */
114 struct backoff_timer {
119 /* split target registers into multiple class */
120 enum target_register_class {
125 /* target_type.h contains the full definition of struct target_type */
127 struct target_type *type; /* target type definition (name, access functions) */
128 char *cmd_name; /* tcl Name of target */
129 int target_number; /* DO NOT USE! field to be removed in 2010 */
130 struct jtag_tap *tap; /* where on the jtag chain is this */
131 int32_t coreid; /* which device on the TAP? */
133 /** Should we defer examine to later */
137 * Indicates whether this target has been examined.
139 * Do @b not access this field directly, use target_was_examined()
140 * or target_set_examined().
145 * true if the target is currently running a downloaded
146 * "algorithm" instead of arbitrary user code. OpenOCD code
147 * invoking algorithms is trusted to maintain correctness of
148 * any cached state (e.g. for flash status), which arbitrary
149 * code will have no reason to know about.
153 struct target_event_action *event_action;
155 int reset_halt; /* attempt resetting the CPU into the halted mode? */
156 target_addr_t working_area; /* working area (initialised RAM). Evaluated
157 * upon first allocation from virtual/physical address. */
158 bool working_area_virt_spec; /* virtual address specified? */
159 target_addr_t working_area_virt; /* virtual address */
160 bool working_area_phys_spec; /* physical address specified? */
161 target_addr_t working_area_phys; /* physical address */
162 uint32_t working_area_size; /* size in bytes */
163 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
164 struct working_area *working_areas;/* list of allocated working areas */
165 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
166 enum target_endianness endianness; /* target endianness */
167 /* also see: target_state_name() */
168 enum target_state state; /* the current backend-state (running, halted, ...) */
169 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
170 struct breakpoint *breakpoints; /* list of breakpoints */
171 struct watchpoint *watchpoints; /* list of watchpoints */
172 struct trace *trace_info; /* generic trace information */
173 struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
174 uint32_t dbg_msg_enabled; /* debug message status */
175 void *arch_info; /* architecture specific information */
176 void *private_config; /* pointer to target specific config data (for jim_configure hook) */
177 struct target *next; /* next target in list */
179 int display; /* display async info in telnet session. Do not display
180 * lots of halted/resumed info when stepping in debugger. */
181 bool halt_issued; /* did we transition to halted state? */
182 int64_t halt_issued_time; /* Note time when halt was issued */
184 bool dbgbase_set; /* By default the debug base is not set */
185 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
186 * system in place to support target specific options
189 bool ctibase_set; /* By default the debug base is not set */
190 uint32_t ctibase; /* Really a Cortex-A specific option, but there is no
191 * system in place to support target specific options
193 struct rtos *rtos; /* Instance of Real Time Operating System support */
194 bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
195 * and must be detected when symbols are offered */
196 struct backoff_timer backoff;
197 int smp; /* add some target attributes for smp support */
198 struct target_list *head;
199 /* the gdb service is there in case of smp, we have only one gdb server
201 * the target attached to the gdb is changing dynamically by changing
202 * gdb_service->target pointer */
203 struct gdb_service *gdb_service;
205 /* file-I/O information for host to do syscall */
206 struct gdb_fileio_info *fileio_info;
210 struct target *target;
211 struct target_list *next;
214 struct gdb_fileio_info {
222 /** Returns the instance-specific name of the specified target. */
223 static inline const char *target_name(struct target *target)
225 return target->cmd_name;
228 const char *debug_reason_name(struct target *t);
232 /* allow GDB to do stuff before others handle the halted event,
233 * this is in lieu of defining ordering of invocation of events,
234 * which would be more complicated
236 * Telling GDB to halt does not mean that the target stopped running,
237 * simply that we're dropping out of GDB's waiting for step or continue.
239 * This can be useful when e.g. detecting power dropout.
241 TARGET_EVENT_GDB_HALT,
242 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
243 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
244 TARGET_EVENT_RESUME_START,
245 TARGET_EVENT_RESUME_END,
247 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
248 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
250 TARGET_EVENT_RESET_START,
251 TARGET_EVENT_RESET_ASSERT_PRE,
252 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
253 TARGET_EVENT_RESET_ASSERT_POST,
254 TARGET_EVENT_RESET_DEASSERT_PRE,
255 TARGET_EVENT_RESET_DEASSERT_POST,
256 TARGET_EVENT_RESET_INIT,
257 TARGET_EVENT_RESET_END,
259 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
260 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
262 TARGET_EVENT_EXAMINE_START,
263 TARGET_EVENT_EXAMINE_END,
265 TARGET_EVENT_GDB_ATTACH,
266 TARGET_EVENT_GDB_DETACH,
268 TARGET_EVENT_GDB_FLASH_ERASE_START,
269 TARGET_EVENT_GDB_FLASH_ERASE_END,
270 TARGET_EVENT_GDB_FLASH_WRITE_START,
271 TARGET_EVENT_GDB_FLASH_WRITE_END,
273 TARGET_EVENT_TRACE_CONFIG,
276 struct target_event_action {
277 enum target_event event;
278 struct Jim_Interp *interp;
279 struct Jim_Obj *body;
281 struct target_event_action *next;
284 bool target_has_event_action(struct target *target, enum target_event event);
286 struct target_event_callback {
287 int (*callback)(struct target *target, enum target_event event, void *priv);
289 struct target_event_callback *next;
292 struct target_reset_callback {
293 struct list_head list;
295 int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
298 struct target_trace_callback {
299 struct list_head list;
301 int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
304 struct target_timer_callback {
305 int (*callback)(void *priv);
311 struct target_timer_callback *next;
314 int target_register_commands(struct command_context *cmd_ctx);
315 int target_examine(void);
317 int target_register_event_callback(
318 int (*callback)(struct target *target,
319 enum target_event event, void *priv),
321 int target_unregister_event_callback(
322 int (*callback)(struct target *target,
323 enum target_event event, void *priv),
326 int target_register_reset_callback(
327 int (*callback)(struct target *target,
328 enum target_reset_mode reset_mode, void *priv),
330 int target_unregister_reset_callback(
331 int (*callback)(struct target *target,
332 enum target_reset_mode reset_mode, void *priv),
335 int target_register_trace_callback(
336 int (*callback)(struct target *target,
337 size_t len, uint8_t *data, void *priv),
339 int target_unregister_trace_callback(
340 int (*callback)(struct target *target,
341 size_t len, uint8_t *data, void *priv),
344 /* Poll the status of the target, detect any error conditions and report them.
346 * Also note that this fn will clear such error conditions, so a subsequent
347 * invocation will then succeed.
349 * These error conditions can be "sticky" error conditions. E.g. writing
350 * to memory could be implemented as an open loop and if memory writes
351 * fails, then a note is made of it, the error is sticky, but the memory
352 * write loop still runs to completion. This improves performance in the
353 * normal case as there is no need to verify that every single write succeed,
354 * yet it is possible to detect error conditions.
356 int target_poll(struct target *target);
357 int target_resume(struct target *target, int current, target_addr_t address,
358 int handle_breakpoints, int debug_execution);
359 int target_halt(struct target *target);
360 int target_call_event_callbacks(struct target *target, enum target_event event);
361 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
362 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
365 * The period is very approximate, the callback can happen much more often
366 * or much more rarely than specified
368 int target_register_timer_callback(int (*callback)(void *priv),
369 int time_ms, int periodic, void *priv);
370 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
371 int target_call_timer_callbacks(void);
373 * Invoke this to ensure that e.g. polling timer callbacks happen before
374 * a synchronous command completes.
376 int target_call_timer_callbacks_now(void);
378 struct target *get_target_by_num(int num);
379 struct target *get_current_target(struct command_context *cmd_ctx);
380 struct target *get_target(const char *id);
383 * Get the target type name.
385 * This routine is a wrapper for the target->type->name field.
386 * Note that this is not an instance-specific name for his target.
388 const char *target_type_name(struct target *target);
391 * Examine the specified @a target, letting it perform any
392 * Initialisation that requires JTAG access.
394 * This routine is a wrapper for target->type->examine.
396 int target_examine_one(struct target *target);
398 /** @returns @c true if target_set_examined() has been called. */
399 static inline bool target_was_examined(struct target *target)
401 return target->examined;
404 /** Sets the @c examined flag for the given target. */
405 /** Use in target->type->examine() after one-time setup is done. */
406 static inline void target_set_examined(struct target *target)
408 target->examined = true;
412 * Add the @a breakpoint for @a target.
414 * This routine is a wrapper for target->type->add_breakpoint.
416 int target_add_breakpoint(struct target *target,
417 struct breakpoint *breakpoint);
419 * Add the @a ContextID breakpoint for @a target.
421 * This routine is a wrapper for target->type->add_context_breakpoint.
423 int target_add_context_breakpoint(struct target *target,
424 struct breakpoint *breakpoint);
426 * Add the @a ContextID & IVA breakpoint for @a target.
428 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
430 int target_add_hybrid_breakpoint(struct target *target,
431 struct breakpoint *breakpoint);
433 * Remove the @a breakpoint for @a target.
435 * This routine is a wrapper for target->type->remove_breakpoint.
438 int target_remove_breakpoint(struct target *target,
439 struct breakpoint *breakpoint);
441 * Add the @a watchpoint for @a target.
443 * This routine is a wrapper for target->type->add_watchpoint.
445 int target_add_watchpoint(struct target *target,
446 struct watchpoint *watchpoint);
448 * Remove the @a watchpoint for @a target.
450 * This routine is a wrapper for target->type->remove_watchpoint.
452 int target_remove_watchpoint(struct target *target,
453 struct watchpoint *watchpoint);
456 * Find out the just hit @a watchpoint for @a target.
458 * This routine is a wrapper for target->type->hit_watchpoint.
460 int target_hit_watchpoint(struct target *target,
461 struct watchpoint **watchpoint);
464 * Obtain the registers for GDB.
466 * This routine is a wrapper for target->type->get_gdb_reg_list.
468 int target_get_gdb_reg_list(struct target *target,
469 struct reg **reg_list[], int *reg_list_size,
470 enum target_register_class reg_class);
475 * This routine is a wrapper for target->type->step.
477 int target_step(struct target *target,
478 int current, target_addr_t address, int handle_breakpoints);
480 * Run an algorithm on the @a target given.
482 * This routine is a wrapper for target->type->run_algorithm.
484 int target_run_algorithm(struct target *target,
485 int num_mem_params, struct mem_param *mem_params,
486 int num_reg_params, struct reg_param *reg_param,
487 uint32_t entry_point, uint32_t exit_point,
488 int timeout_ms, void *arch_info);
491 * Starts an algorithm in the background on the @a target given.
493 * This routine is a wrapper for target->type->start_algorithm.
495 int target_start_algorithm(struct target *target,
496 int num_mem_params, struct mem_param *mem_params,
497 int num_reg_params, struct reg_param *reg_params,
498 uint32_t entry_point, uint32_t exit_point,
502 * Wait for an algorithm on the @a target given.
504 * This routine is a wrapper for target->type->wait_algorithm.
506 int target_wait_algorithm(struct target *target,
507 int num_mem_params, struct mem_param *mem_params,
508 int num_reg_params, struct reg_param *reg_params,
509 uint32_t exit_point, int timeout_ms,
513 * This routine is a wrapper for asynchronous algorithms.
516 int target_run_flash_async_algorithm(struct target *target,
517 const uint8_t *buffer, uint32_t count, int block_size,
518 int num_mem_params, struct mem_param *mem_params,
519 int num_reg_params, struct reg_param *reg_params,
520 uint32_t buffer_start, uint32_t buffer_size,
521 uint32_t entry_point, uint32_t exit_point,
525 * Read @a count items of @a size bytes from the memory of @a target at
526 * the @a address given.
528 * This routine is a wrapper for target->type->read_memory.
530 int target_read_memory(struct target *target,
531 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
532 int target_read_phys_memory(struct target *target,
533 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
535 * Write @a count items of @a size bytes to the memory of @a target at
536 * the @a address given. @a address must be aligned to @a size
539 * The endianness is the same in the host and target memory for this
543 * Really @a buffer should have been defined as "const void *" and
544 * @a buffer should have been aligned to @a size in the host memory.
546 * This is not enforced via e.g. assert's today and e.g. the
547 * target_write_buffer fn breaks this assumption.
549 * This routine is wrapper for target->type->write_memory.
551 int target_write_memory(struct target *target,
552 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
553 int target_write_phys_memory(struct target *target,
554 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
557 * Write to target memory using the virtual address.
559 * Note that this fn is used to implement software breakpoints. Targets
560 * can implement support for software breakpoints to memory marked as read
561 * only by making this fn write to ram even if it is read only(MMU or
564 * It is sufficient to implement for writing a single word(16 or 32 in
565 * ARM32/16 bit case) to write the breakpoint to ram.
567 * The target should also take care of "other things" to make sure that
568 * software breakpoints can be written using this function. E.g.
569 * when there is a separate instruction and data cache, this fn must
570 * make sure that the instruction cache is synced up to the potential
571 * code change that can happen as a result of the memory write(typically
572 * by invalidating the cache).
574 * The high level wrapper fn in target.c will break down this memory write
575 * request to multiple write requests to the target driver to e.g. guarantee
576 * that writing 4 bytes to an aligned address happens with a single 32 bit
577 * write operation, thus making this fn suitable to e.g. write to special
578 * peripheral registers which do not support byte operations.
580 int target_write_buffer(struct target *target,
581 target_addr_t address, uint32_t size, const uint8_t *buffer);
582 int target_read_buffer(struct target *target,
583 target_addr_t address, uint32_t size, uint8_t *buffer);
584 int target_checksum_memory(struct target *target,
585 target_addr_t address, uint32_t size, uint32_t *crc);
586 int target_blank_check_memory(struct target *target,
587 target_addr_t address, uint32_t size, uint32_t *blank, uint8_t erased_value);
588 int target_wait_state(struct target *target, enum target_state state, int ms);
591 * Obtain file-I/O information from target for GDB to do syscall.
593 * This routine is a wrapper for target->type->get_gdb_fileio_info.
595 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
598 * Pass GDB file-I/O response to target after finishing host syscall.
600 * This routine is a wrapper for target->type->gdb_fileio_end.
602 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
606 /** Return the *name* of this targets current state */
607 const char *target_state_name(struct target *target);
609 /** Return the *name* of a target event enumeration value */
610 const char *target_event_name(enum target_event event);
612 /** Return the *name* of a target reset reason enumeration value */
613 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
617 * if "area" passed in to target_alloc_working_area() points to a memory
618 * location that goes out of scope (e.g. a pointer on the stack), then
619 * the caller of target_alloc_working_area() is responsible for invoking
620 * target_free_working_area() before "area" goes out of scope.
622 * target_free_all_working_areas() will NULL out the "area" pointer
623 * upon resuming or resetting the CPU.
626 int target_alloc_working_area(struct target *target,
627 uint32_t size, struct working_area **area);
628 /* Same as target_alloc_working_area, except that no error is logged
629 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
631 * This allows the calling code to *try* to allocate target memory
632 * and have a fallback to another behaviour(slower?).
634 int target_alloc_working_area_try(struct target *target,
635 uint32_t size, struct working_area **area);
636 int target_free_working_area(struct target *target, struct working_area *area);
637 void target_free_all_working_areas(struct target *target);
638 uint32_t target_get_working_area_avail(struct target *target);
641 * Free all the resources allocated by targets and the target layer
643 void target_quit(void);
645 extern struct target *all_targets;
647 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
648 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
649 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
650 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
651 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
652 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
653 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
654 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
656 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
657 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
658 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
659 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
660 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
661 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
663 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
664 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
665 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
666 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
667 int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
668 int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
669 int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
670 int target_write_u8(struct target *target, target_addr_t address, uint8_t value);
672 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
673 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
674 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
675 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
677 /* Issues USER() statements with target state information */
678 int target_arch_state(struct target *target);
680 void target_handle_event(struct target *t, enum target_event e);
682 #define ERROR_TARGET_INVALID (-300)
683 #define ERROR_TARGET_INIT_FAILED (-301)
684 #define ERROR_TARGET_TIMEOUT (-302)
685 #define ERROR_TARGET_NOT_HALTED (-304)
686 #define ERROR_TARGET_FAILURE (-305)
687 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
688 #define ERROR_TARGET_DATA_ABORT (-307)
689 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
690 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
691 #define ERROR_TARGET_NOT_RUNNING (-310)
692 #define ERROR_TARGET_NOT_EXAMINED (-311)
694 extern bool get_target_reset_nag(void);
696 #endif /* OPENOCD_TARGET_TARGET_H */