X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Ftarget%2Ftarget.h;h=9382720b9693ef880fc04d9f1c415eb3e40a237b;hp=4a48e5aad6c08c892d16e57d9d3d3fde1b74e83c;hb=a09a75653dbe7ad99da6349285ab6622b80fdc15;hpb=8865209545dae9c2745927758a51c60f922e02ca diff --git a/src/target/target.h b/src/target/target.h index 4a48e5aad6..9382720b96 100644 --- a/src/target/target.h +++ b/src/target/target.h @@ -8,6 +8,12 @@ * Copyright (C) 2008 by Spencer Oliver * * spen@spen-soft.co.uk * * * + * Copyright (C) 2011 by Broadcom Corporation * + * Evan Hunter - ehunter@broadcom.com * + * * + * Copyright (C) ST-Ericsson SA 2011 * + * michel.jaouen@stericsson.com : smp minimum support * + * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * @@ -21,12 +27,13 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifndef TARGET_H #define TARGET_H -#include +#include struct reg; struct trace; @@ -35,7 +42,8 @@ struct breakpoint; struct watchpoint; struct mem_param; struct reg_param; - +struct target_list; +struct gdb_fileio_info; /* * TARGET_UNKNOWN = 0: we don't know anything about the target yet @@ -50,9 +58,7 @@ struct reg_param; * also see: target_state_name(); */ - -enum target_state -{ +enum target_state { TARGET_UNKNOWN = 0, TARGET_RUNNING = 1, TARGET_HALTED = 2, @@ -65,49 +71,66 @@ enum nvp_assert { NVP_ASSERT, }; -enum target_reset_mode -{ +enum target_reset_mode { RESET_UNKNOWN = 0, RESET_RUN = 1, /* reset and let target run */ RESET_HALT = 2, /* reset and halt target out of reset */ RESET_INIT = 3, /* reset and halt target out of reset, then run init script */ }; -enum target_debug_reason -{ +enum target_debug_reason { DBG_REASON_DBGRQ = 0, DBG_REASON_BREAKPOINT = 1, DBG_REASON_WATCHPOINT = 2, DBG_REASON_WPTANDBKPT = 3, DBG_REASON_SINGLESTEP = 4, DBG_REASON_NOTHALTED = 5, - DBG_REASON_UNDEFINED = 6 + DBG_REASON_EXIT = 6, + DBG_REASON_UNDEFINED = 7, }; -enum target_endianess -{ +enum target_endianness { TARGET_ENDIAN_UNKNOWN = 0, TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2 }; -struct working_area -{ +struct working_area { uint32_t address; uint32_t size; - int free; + bool free; uint8_t *backup; struct working_area **user; struct working_area *next; }; -// target_type.h contains the full definitionof struct targe_type -struct target -{ - struct target_type *type; /* target type definition (name, access functions) */ +struct gdb_service { + struct target *target; + /* field for smp display */ + /* element 0 coreid currently displayed ( 1 till n) */ + /* element 1 coreid to be displayed at next resume 1 till n 0 means resume + * all cores core displayed */ + int32_t core[2]; +}; + +/* target back off timer */ +struct backoff_timer { + int times; + int count; +}; + +/* split target registers into multiple class */ +enum target_register_class { + REG_CLASS_ALL, + REG_CLASS_GENERAL, +}; + +/* target_type.h contains the full definition of struct target_type */ +struct target { + struct target_type *type; /* target type definition (name, access functions) */ const char *cmd_name; /* tcl Name of target */ int target_number; /* DO NOT USE! field to be removed in 2010 */ - struct jtag_tap *tap; /* where on the jtag chain is this */ - const char *variant; /* what variant of this chip is it? */ + struct jtag_tap *tap; /* where on the jtag chain is this */ + int32_t coreid; /* which device on the TAP? */ /** * Indicates whether this target has been examined. @@ -117,36 +140,37 @@ struct target */ bool examined; - /** true iff the target is currently running a downloaded - * "algorithm" instetad of arbitrary user code. OpenOCD code - * invoking algorithms is trusted to maintain correctness of - * any cached state (e.g. for flash status), which arbitrary - * code will have no reason to know about. + /** + * true if the target is currently running a downloaded + * "algorithm" instead of arbitrary user code. OpenOCD code + * invoking algorithms is trusted to maintain correctness of + * any cached state (e.g. for flash status), which arbitrary + * code will have no reason to know about. */ bool running_alg; struct target_event_action *event_action; int reset_halt; /* attempt resetting the CPU into the halted mode? */ - uint32_t working_area; /* working area (initialized RAM). Evaluated + uint32_t working_area; /* working area (initialised RAM). Evaluated * upon first allocation from virtual/physical address. */ bool working_area_virt_spec; /* virtual address specified? */ uint32_t working_area_virt; /* virtual address */ bool working_area_phys_spec; /* virtual address specified? */ uint32_t working_area_phys; /* physical address */ uint32_t working_area_size; /* size in bytes */ - uint32_t backup_working_area; /* whether the content of the working area has to be preserved */ + uint32_t backup_working_area; /* whether the content of the working area has to be preserved */ struct working_area *working_areas;/* list of allocated working areas */ enum target_debug_reason debug_reason;/* reason why the target entered debug state */ - enum target_endianess endianness; /* target endianess */ - // also see: target_state_name() + enum target_endianness endianness; /* target endianness */ + /* also see: target_state_name() */ enum target_state state; /* the current backend-state (running, halted, ...) */ struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */ - struct breakpoint *breakpoints; /* list of breakpoints */ - struct watchpoint *watchpoints; /* list of watchpoints */ + struct breakpoint *breakpoints; /* list of breakpoints */ + struct watchpoint *watchpoints; /* list of watchpoints */ struct trace *trace_info; /* generic trace information */ - struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */ - uint32_t dbg_msg_enabled; /* debug message status */ + struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */ + uint32_t dbg_msg_enabled; /* debug message status */ void *arch_info; /* architecture specific information */ struct target *next; /* next target in list */ @@ -154,6 +178,38 @@ struct target * lots of halted/resumed info when stepping in debugger. */ bool halt_issued; /* did we transition to halted state? */ long long halt_issued_time; /* Note time when halt was issued */ + + bool dbgbase_set; /* By default the debug base is not set */ + uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no + * system in place to support target specific options + * currently. */ + struct rtos *rtos; /* Instance of Real Time Operating System support */ + bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto" + * and must be detected when symbols are offered */ + struct backoff_timer backoff; + int smp; /* add some target attributes for smp support */ + struct target_list *head; + /* the gdb service is there in case of smp, we have only one gdb server + * for all smp target + * the target attached to the gdb is changing dynamically by changing + * gdb_service->target pointer */ + struct gdb_service *gdb_service; + + /* file-I/O information for host to do syscall */ + struct gdb_fileio_info *fileio_info; +}; + +struct target_list { + struct target *target; + struct target_list *next; +}; + +struct gdb_fileio_info { + char *identifier; + uint32_t param_1; + uint32_t param_2; + uint32_t param_3; + uint32_t param_4; }; /** Returns the instance-specific name of the specified target. */ @@ -164,14 +220,7 @@ static inline const char *target_name(struct target *target) const char *debug_reason_name(struct target *t); -enum target_event -{ - /* LD historical names - * - Prior to the great TCL change - * - June/July/Aug 2008 - * - Duane Ellis */ - TARGET_EVENT_OLD_gdb_program_config, - TARGET_EVENT_OLD_pre_resume, +enum target_event { /* allow GDB to do stuff before others handle the halted event, * this is in lieu of defining ordering of invocation of events, @@ -217,6 +266,8 @@ enum target_event TARGET_EVENT_GDB_FLASH_ERASE_END, TARGET_EVENT_GDB_FLASH_WRITE_START, TARGET_EVENT_GDB_FLASH_WRITE_END, + + TARGET_EVENT_TRACE_CONFIG, }; struct target_event_action { @@ -229,18 +280,23 @@ struct target_event_action { bool target_has_event_action(struct target *target, enum target_event event); -struct target_event_callback -{ +struct target_event_callback { int (*callback)(struct target *target, enum target_event event, void *priv); void *priv; struct target_event_callback *next; }; -struct target_timer_callback -{ +struct target_reset_callback { + struct list_head list; + void *priv; + int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv); +}; + +struct target_timer_callback { int (*callback)(void *priv); int time_ms; int periodic; + bool removed; struct timeval when; void *priv; struct target_timer_callback *next; @@ -251,17 +307,40 @@ int target_examine(void); int target_register_event_callback( int (*callback)(struct target *target, - enum target_event event, void *priv), + enum target_event event, void *priv), void *priv); int target_unregister_event_callback( int (*callback)(struct target *target, - enum target_event event, void *priv), + enum target_event event, void *priv), void *priv); + +int target_register_reset_callback( + int (*callback)(struct target *target, + enum target_reset_mode reset_mode, void *priv), + void *priv); +int target_unregister_reset_callback( + int (*callback)(struct target *target, + enum target_reset_mode reset_mode, void *priv), + void *priv); + +/* Poll the status of the target, detect any error conditions and report them. + * + * Also note that this fn will clear such error conditions, so a subsequent + * invocation will then succeed. + * + * These error conditions can be "sticky" error conditions. E.g. writing + * to memory could be implemented as an open loop and if memory writes + * fails, then a note is made of it, the error is sticky, but the memory + * write loop still runs to completion. This improves performance in the + * normal case as there is no need to verify that every single write succeed, + * yet it is possible to detect error conditions. + */ int target_poll(struct target *target); int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution); int target_halt(struct target *target); int target_call_event_callbacks(struct target *target, enum target_event event); +int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode); /** * The period is very approximate, the callback can happen much more often @@ -269,15 +348,15 @@ int target_call_event_callbacks(struct target *target, enum target_event event); */ int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv); - +int target_unregister_timer_callback(int (*callback)(void *priv), void *priv); int target_call_timer_callbacks(void); /** * Invoke this to ensure that e.g. polling timer callbacks happen before - * a syncrhonous command completes. + * a synchronous command completes. */ int target_call_timer_callbacks_now(void); -struct target* get_current_target(struct command_context *cmd_ctx); +struct target *get_current_target(struct command_context *cmd_ctx); struct target *get_target(const char *id); /** @@ -290,20 +369,20 @@ const char *target_type_name(struct target *target); /** * Examine the specified @a target, letting it perform any - * initialization that requires JTAG access. + * Initialisation that requires JTAG access. * * This routine is a wrapper for target->type->examine. */ int target_examine_one(struct target *target); -/// @returns @c true if target_set_examined() has been called. +/** @returns @c true if target_set_examined() has been called. */ static inline bool target_was_examined(struct target *target) { return target->examined; } -/// Sets the @c examined flag for the given target. -/// Use in target->type->examine() after one-time setup is done. +/** Sets the @c examined flag for the given target. */ +/** Use in target->type->examine() after one-time setup is done. */ static inline void target_set_examined(struct target *target) { target->examined = true; @@ -316,11 +395,26 @@ static inline void target_set_examined(struct target *target) */ int target_add_breakpoint(struct target *target, struct breakpoint *breakpoint); +/** + * Add the @a ContextID breakpoint for @a target. + * + * This routine is a wrapper for target->type->add_context_breakpoint. + */ +int target_add_context_breakpoint(struct target *target, + struct breakpoint *breakpoint); +/** + * Add the @a ContextID & IVA breakpoint for @a target. + * + * This routine is a wrapper for target->type->add_hybrid_breakpoint. + */ +int target_add_hybrid_breakpoint(struct target *target, + struct breakpoint *breakpoint); /** * Remove the @a breakpoint for @a target. * * This routine is a wrapper for target->type->remove_breakpoint. */ + int target_remove_breakpoint(struct target *target, struct breakpoint *breakpoint); /** @@ -338,13 +432,22 @@ int target_add_watchpoint(struct target *target, int target_remove_watchpoint(struct target *target, struct watchpoint *watchpoint); +/** + * Find out the just hit @a watchpoint for @a target. + * + * This routine is a wrapper for target->type->hit_watchpoint. + */ +int target_hit_watchpoint(struct target *target, + struct watchpoint **watchpoint); + /** * Obtain the registers for GDB. * * This routine is a wrapper for target->type->get_gdb_reg_list. */ int target_get_gdb_reg_list(struct target *target, - struct reg **reg_list[], int *reg_list_size); + struct reg **reg_list[], int *reg_list_size, + enum target_register_class reg_class); /** * Step the target. @@ -364,6 +467,40 @@ int target_run_algorithm(struct target *target, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info); +/** + * Starts an algorithm in the background on the @a target given. + * + * This routine is a wrapper for target->type->start_algorithm. + */ +int target_start_algorithm(struct target *target, + int num_mem_params, struct mem_param *mem_params, + int num_reg_params, struct reg_param *reg_params, + uint32_t entry_point, uint32_t exit_point, + void *arch_info); + +/** + * Wait for an algorithm on the @a target given. + * + * This routine is a wrapper for target->type->wait_algorithm. + */ +int target_wait_algorithm(struct target *target, + int num_mem_params, struct mem_param *mem_params, + int num_reg_params, struct reg_param *reg_params, + uint32_t exit_point, int timeout_ms, + void *arch_info); + +/** + * This routine is a wrapper for asynchronous algorithms. + * + */ +int target_run_flash_async_algorithm(struct target *target, + const uint8_t *buffer, uint32_t count, int block_size, + int num_mem_params, struct mem_param *mem_params, + int num_reg_params, struct reg_param *reg_params, + uint32_t buffer_start, uint32_t buffer_size, + uint32_t entry_point, uint32_t exit_point, + void *arch_info); + /** * Read @a count items of @a size bytes from the memory of @a target at * the @a address given. @@ -372,6 +509,8 @@ int target_run_algorithm(struct target *target, */ int target_read_memory(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer); +int target_read_phys_memory(struct target *target, + uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer); /** * Write @a count items of @a size bytes to the memory of @a target at * the @a address given. @a address must be aligned to @a size @@ -390,17 +529,9 @@ int target_read_memory(struct target *target, * This routine is wrapper for target->type->write_memory. */ int target_write_memory(struct target *target, - uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer); - -/** - * Write @a count items of 4 bytes to the memory of @a target at - * the @a address given. Because it operates only on whole words, - * this should be faster than target_write_memory(). - * - * This routine is wrapper for target->type->bulk_write_memory. - */ -int target_bulk_write_memory(struct target *target, - uint32_t address, uint32_t count, uint8_t *buffer); + uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer); +int target_write_phys_memory(struct target *target, + uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer); /* * Write to target memory using the virtual address. @@ -427,17 +558,39 @@ int target_bulk_write_memory(struct target *target, * peripheral registers which do not support byte operations. */ int target_write_buffer(struct target *target, - uint32_t address, uint32_t size, uint8_t *buffer); + uint32_t address, uint32_t size, const uint8_t *buffer); int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer); int target_checksum_memory(struct target *target, - uint32_t address, uint32_t size, uint32_t* crc); + uint32_t address, uint32_t size, uint32_t *crc); int target_blank_check_memory(struct target *target, - uint32_t address, uint32_t size, uint32_t* blank); + uint32_t address, uint32_t size, uint32_t *blank); int target_wait_state(struct target *target, enum target_state state, int ms); +/** + * Obtain file-I/O information from target for GDB to do syscall. + * + * This routine is a wrapper for target->type->get_gdb_fileio_info. + */ +int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info); + +/** + * Pass GDB file-I/O response to target after finishing host syscall. + * + * This routine is a wrapper for target->type->gdb_fileio_end. + */ +int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c); + + + /** Return the *name* of this targets current state */ -const char *target_state_name( struct target *target ); +const char *target_state_name(struct target *target); + +/** Return the *name* of a target event enumeration value */ +const char *target_event_name(enum target_event event); + +/** Return the *name* of a target reset reason enumeration value */ +const char *target_reset_mode_name(enum target_reset_mode reset_mode); /* DANGER!!!!! * @@ -456,23 +609,42 @@ int target_alloc_working_area(struct target *target, * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned. * * This allows the calling code to *try* to allocate target memory - * and have a fallback to another behavior(slower?). + * and have a fallback to another behaviour(slower?). */ int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area); int target_free_working_area(struct target *target, struct working_area *area); void target_free_all_working_areas(struct target *target); +uint32_t target_get_working_area_avail(struct target *target); + +/** + * Free all the resources allocated by targets and the target layer + */ +void target_quit(void); extern struct target *all_targets; +uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer); uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer); +uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer); uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer); +void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value); void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value); +void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value); void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value); +void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf); +void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf); +void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf); +void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf); +void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf); +void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf); + +int target_read_u64(struct target *target, uint64_t address, uint64_t *value); int target_read_u32(struct target *target, uint32_t address, uint32_t *value); int target_read_u16(struct target *target, uint32_t address, uint16_t *value); int target_read_u8(struct target *target, uint32_t address, uint8_t *value); +int target_write_u64(struct target *target, uint64_t address, uint64_t value); int target_write_u32(struct target *target, uint32_t address, uint32_t value); int target_write_u16(struct target *target, uint32_t address, uint16_t value); int target_write_u8(struct target *target, uint32_t address, uint8_t value);