X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Ftarget%2Ftarget.h;h=c60960e5e114f5daa1fee895b62647eea965169f;hp=9674c473c150409869c4bb6a82ca964329721685;hb=93459582fd340e4f63efed0fab9abd49a2cb6373;hpb=11edf227768f41b2a96c0d26a871f9e5f89d259a diff --git a/src/target/target.h b/src/target/target.h index 9674c473c1..c60960e5e1 100644 --- a/src/target/target.h +++ b/src/target/target.h @@ -2,7 +2,7 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008,2009 Øyvind Harboe * * oyvind.harboe@zylin.com * * * * Copyright (C) 2008 by Spencer Oliver * @@ -26,6 +26,8 @@ #ifndef TARGET_H #define TARGET_H +#include + #include "breakpoints.h" #include "algorithm.h" #include "command.h" @@ -34,6 +36,19 @@ struct reg_s; struct trace_s; struct command_context_s; + +/** + * Cast a member of a structure out to the containing structure. + * @param ptr The pointer to the member. + * @param type The type of the container struct this is embedded in. + * @param member The name of the member within the struct. + * + * This is a mechanism which is used throughout the Linux kernel. + */ +#define container_of(ptr, type, member) ({ \ + const typeof( ((type *)0)->member ) *__mptr = (ptr); \ + (type *)( (char *)__mptr - offsetof(type,member) );}) + /* * TARGET_UNKNOWN = 0: we don't know anything about the target yet * TARGET_RUNNING = 1: the target is executing user code @@ -42,7 +57,11 @@ struct command_context_s; * TARGET_RESET = 3: the target is being held in reset (only a temporary state, * not sure how this is used with all the recent changes) * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on - * behalf of the debugger (e.g. algorithm for flashing) */ + * behalf of the debugger (e.g. algorithm for flashing) + * + * also see: target_state_name(); + */ + enum target_state { @@ -87,7 +106,7 @@ extern const Jim_Nvp nvp_target_debug_reason[]; enum target_endianess { - TARGET_ENDIAN_UNKNOWN=0, + TARGET_ENDIAN_UNKNOWN = 0, TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2 }; @@ -95,164 +114,19 @@ extern const Jim_Nvp nvp_target_endian[]; struct target_s; -typedef struct working_area_s +struct working_area { - u32 address; - u32 size; + uint32_t address; + uint32_t size; int free; - u8 *backup; - struct working_area_s **user; - struct working_area_s *next; -} working_area_t; - -typedef struct target_type_s -{ - char *name; - - /** - * Indicates whether this target has been examined. - * - * Do @b not access this field directly, use target_was_examined() - * target_set_examined(), and target_reset_examined(). - */ - int examined; - - /* poll current target status */ - int (*poll)(struct target_s *target); - /* Invoked only from target_arch_state(). - * Issue USER() w/architecture specific status. */ - int (*arch_state)(struct target_s *target); - - /* target request support */ - int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer); - - /* halt will log a warning, but return ERROR_OK if the target is already halted. */ - int (*halt)(struct target_s *target); - int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution); - int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints); - - /* target reset control. assert reset can be invoked when OpenOCD and - * the target is out of sync. - * - * A typical example is that the target was power cycled while OpenOCD - * thought the target was halted or running. - * - * assert_reset() can therefore make no assumptions whatsoever about the - * state of the target - * - * Before assert_reset() for the target is invoked, a TRST/tms and - * chain validation is executed. TRST should not be asserted - * during target assert unless there is no way around it due to - * the way reset's are configured. - * - */ - int (*assert_reset)(struct target_s *target); - int (*deassert_reset)(struct target_s *target); - int (*soft_reset_halt_imp)(struct target_s *target); - int (*soft_reset_halt)(struct target_s *target); - - /* target register access for gdb. - * - * Danger! this function will succeed even if the target is running - * and return a register list with dummy values. - * - * The reason is that GDB connection will fail without a valid register - * list, however it is after GDB is connected that monitor commands can - * be run to properly initialize the target - */ - int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size); - - /* target memory access - * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit) - * count: number of items of - */ - int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer); - /** - * Target memory read callback. Do @b not call this function - * directly, use target_read_memory() instead. - */ - int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer); - int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer); - /** - * Target memory write callback. Do @b not call this function - * directly, use target_write_memory() instead. - */ - int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer); - - /** - * Write target memory in multiples of 4 bytes, optimized for - * writing large quantities of data. Do @b not call this - * function directly, use target_bulk_write_memory() instead. - */ - int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer); - - int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum); - int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank); - - /* - * target break-/watchpoint control - * rw: 0 = write, 1 = read, 2 = access - * - * Target must be halted while this is invoked as this - * will actually set up breakpoints on target. - * - * The breakpoint hardware will be set up upon adding the first breakpoint. - * - * Upon GDB connection all breakpoints/watchpoints are cleared. - */ - int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint); - - /* remove breakpoint. hw will only be updated if the target is currently halted. - * However, this method can be invoked on unresponsive targets. - */ - int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint); - int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint); - /* remove watchpoint. hw will only be updated if the target is currently halted. - * However, this method can be invoked on unresponsive targets. - */ - int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint); - - /* target algorithm support */ - 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); - /** - * Target algorithm support. Do @b not call this method directly, - * use target_run_algorithm() instead. - */ - 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); - - int (*register_commands)(struct command_context_s *cmd_ctx); - - /* called when target is created */ - int (*target_create)( struct target_s *target, Jim_Interp *interp ); - - /* called for various config parameters */ - /* returns JIM_CONTINUE - if option not understood */ - /* otherwise: JIM_OK, or JIM_ERR, */ - int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi ); - - /* target commands specifically handled by the target */ - /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */ - int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi ); - - /* invoked after JTAG chain has been examined & validated. During - * this stage the target is examined and any additional setup is - * performed. - * - * invoked every time after the jtag chain has been validated/examined - */ - int (*examine)(struct target_s *target); - /* Set up structures for target. - * - * It is illegal to talk to the target at this stage as this fn is invoked - * before the JTAG chain has been examined/verified - * */ - int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target); - int (*quit)(void); - - int (*virt2phys)(struct target_s *target, u32 address, u32 *physical); - int (*mmu)(struct target_s *target, int *enabled); + uint8_t *backup; + struct working_area **user; + struct working_area *next; +}; -} target_type_t; +// target_type.h contains the full definitionof struct target_type_s +struct target_type_s; +typedef struct target_type_s target_type_t; /* forward decloration */ typedef struct target_event_action_s target_event_action_t; @@ -261,33 +135,38 @@ typedef struct target_s { target_type_t *type; /* target type definition (name, access functions) */ const char *cmd_name; /* tcl Name of target */ - int target_number; /* generaly, target index but may not be in order */ - jtag_tap_t *tap; /* where on the jtag chain is this */ + 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 varient of this chip is it? */ target_event_action_t *event_action; int reset_halt; /* attempt resetting the CPU into the halted mode? */ - u32 working_area; /* working area (initialized RAM). Evaluated + uint32_t working_area; /* working area (initialized RAM). Evaluated * upon first allocation from virtual/physical address. */ - u32 working_area_virt; /* virtual address */ - u32 working_area_phys; /* physical address */ - u32 working_area_size; /* size in bytes */ - u32 backup_working_area; /* whether the content of the working area has to be preserved */ - struct working_area_s *working_areas;/* list of allocated working areas */ + 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 */ + 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_state state; /* the current backend-state (running, halted, ...) */ - struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */ + struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */ struct breakpoint_s *breakpoints; /* list of breakpoints */ - struct watchpoint_s *watchpoints; /* list of watchpoints */ + struct watchpoint *watchpoints; /* list of watchpoints */ struct trace_s *trace_info; /* generic trace information */ struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */ - u32 dbg_msg_enabled; /* debug message status */ + uint32_t dbg_msg_enabled; /* debug message status */ void *arch_info; /* architecture specific information */ struct target_s *next; /* next target in list */ int display; /* display async info in telnet session. Do not display * 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 */ } target_t; enum target_event @@ -303,8 +182,14 @@ 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, - * which would be more complicated */ - TARGET_EVENT_EARLY_HALTED, + * which would be more complicated + * + * Telling GDB to halt does not mean that the target stopped running, + * simply that we're dropping out of GDB's waiting for step or continue. + * + * This can be useful when e.g. detecting power dropout. + */ + TARGET_EVENT_GDB_HALT, TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */ TARGET_EVENT_RESUMED, /* target resumed to normal execution */ TARGET_EVENT_RESUME_START, @@ -347,102 +232,202 @@ struct target_event_action_s { target_event_action_t *next; }; -typedef struct target_event_callback_s +struct target_event_callback { int (*callback)(struct target_s *target, enum target_event event, void *priv); void *priv; - struct target_event_callback_s *next; -} target_event_callback_t; + struct target_event_callback *next; +}; -typedef struct target_timer_callback_s +struct target_timer_callback { int (*callback)(void *priv); int time_ms; int periodic; struct timeval when; void *priv; - struct target_timer_callback_s *next; -} target_timer_callback_t; - -extern int target_register_commands(struct command_context_s *cmd_ctx); -extern int target_register_user_commands(struct command_context_s *cmd_ctx); -extern int target_init(struct command_context_s *cmd_ctx); -extern int target_examine(void); -extern int handle_target(void *priv); -extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode); - -extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv); -extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv); -extern int target_poll(target_t *target); -extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution); -extern int target_halt(target_t *target); -extern int target_call_event_callbacks(target_t *target, enum target_event event); - -/* The period is very approximate, the callback can happen much more often + struct target_timer_callback *next; +}; + +int target_register_commands(struct command_context_s *cmd_ctx); +int target_register_user_commands(struct command_context_s *cmd_ctx); +int target_init(struct command_context_s *cmd_ctx); +int target_examine(void); +int handle_target(void *priv); +int target_process_reset(struct command_context_s *cmd_ctx, + enum target_reset_mode reset_mode); + +int target_register_event_callback( + int (*callback)(struct target_s *target, + enum target_event event, void *priv), + void *priv); +int target_unregister_event_callback( + int (*callback)(struct target_s *target, + enum target_event event, void *priv), + void *priv); +int target_poll(target_t *target); +int target_resume(target_t *target, int current, uint32_t address, + int handle_breakpoints, int debug_execution); +int target_halt(target_t *target); +int target_call_event_callbacks(target_t *target, enum target_event event); + +/** + * The period is very approximate, the callback can happen much more often * or much more rarely than specified */ -extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv); -extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv); -extern int target_call_timer_callbacks(void); -/* invoke this to ensure that e.g. polling timer callbacks happen before +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. */ -extern int target_call_timer_callbacks_now(void); +int target_call_timer_callbacks_now(void); + +target_t* get_current_target(struct command_context_s *cmd_ctx); +target_t *get_target(const char *id); -extern target_t* get_current_target(struct command_context_s *cmd_ctx); -extern int get_num_by_target(target_t *query_target); -extern target_t *get_target(const char *id); +/** + * Get the target name. + * + * This routine is a wrapper for the target->type->name field. + */ +const char *target_get_name(struct target_s *target); +/** + * Examine the specified @a target. + * + * This routine is a wrapper for target->type->examine. + */ +int target_examine_one(struct target_s *target); /// @returns @c true if the target has been examined. -extern bool target_was_examined(struct target_s *target); +bool target_was_examined(struct target_s *target); /// Sets the @c examined flag for the given target. -extern void target_set_examined(struct target_s *target); +void target_set_examined(struct target_s *target); /// Reset the @c examined flag for the given target. -extern void target_reset_examined(struct target_s *target); +void target_reset_examined(struct target_s *target); + + +/** + * Add the @a breakpoint for @a target. + * + * This routine is a wrapper for target->type->add_breakpoint. + */ +int target_add_breakpoint(struct target_s *target, + struct breakpoint_s *breakpoint); +/** + * Remove the @a breakpoint for @a target. + * + * This routine is a wrapper for target->type->remove_breakpoint. + */ +int target_remove_breakpoint(struct target_s *target, + struct breakpoint_s *breakpoint); +/** + * Add the @a watchpoint for @a target. + * + * This routine is a wrapper for target->type->add_watchpoint. + */ +int target_add_watchpoint(struct target_s *target, + struct watchpoint *watchpoint); +/** + * Remove the @a watchpoint for @a target. + * + * This routine is a wrapper for target->type->remove_watchpoint. + */ +int target_remove_watchpoint(struct target_s *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_s *target, + struct reg_s **reg_list[], int *reg_list_size); +/** + * Step the target. + * + * This routine is a wrapper for target->type->step. + */ +int target_step(struct target_s *target, + int current, uint32_t address, int handle_breakpoints); /** * Run an algorithm on the @a target given. * * This routine is a wrapper for target->type->run_algorithm. */ -extern int target_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 target_run_algorithm(struct target_s *target, + int num_mem_params, struct mem_param *mem_params, + int num_reg_params, struct reg_param *reg_param, + uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info); /** - * Read @count items of @a size bytes from the memory of @a target at + * Read @a count items of @a size bytes from the memory of @a target at * the @a address given. * * This routine is a wrapper for target->type->read_memory. */ -extern int target_read_memory(struct target_s *target, - u32 address, u32 size, u32 count, u8 *buffer); +int target_read_memory(struct target_s *target, + uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer); /** - * Write @count items of @a size bytes to the memory of @a target at + * Write @a count items of @a size bytes to the memory of @a target at * the @a address given. * * This routine is wrapper for target->type->write_memory. */ -extern int target_write_memory(struct target_s *target, - u32 address, u32 size, u32 count, u8 *buffer); +int target_write_memory(struct target_s *target, + uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer); /** - * Write @count items of 4 bytes to the memory of @a target at + * 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. */ -extern int target_bulk_write_memory(struct target_s *target, - u32 address, u32 count, u8 *buffer); +int target_bulk_write_memory(struct target_s *target, + uint32_t address, uint32_t count, uint8_t *buffer); -extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer); -extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer); -extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc); -extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank); -extern int target_wait_state(target_t *target, enum target_state state, int ms); +/* + * Write to target memory using the virtual address. + * + * Note that this fn is used to implement software breakpoints. Targets + * can implement support for software breakpoints to memory marked as read + * only by making this fn write to ram even if it is read only(MMU or + * MPUs). + * + * It is sufficient to implement for writing a single word(16 or 32 in + * ARM32/16 bit case) to write the breakpoint to ram. + * + * The target should also take care of "other things" to make sure that + * software breakpoints can be written using this function. E.g. + * when there is a separate instruction and data cache, this fn must + * make sure that the instruction cache is synced up to the potential + * code change that can happen as a result of the memory write(typically + * by invalidating the cache). + * + * The high level wrapper fn in target.c will break down this memory write + * request to multiple write requests to the target driver to e.g. guarantee + * that writing 4 bytes to an aligned address happens with a single 32 bit + * write operation, thus making this fn suitable to e.g. write to special + * peripheral registers which do not support byte operations. + */ +int target_write_buffer(struct target_s *target, + uint32_t address, uint32_t size, uint8_t *buffer); +int target_read_buffer(struct target_s *target, + uint32_t address, uint32_t size, uint8_t *buffer); +int target_checksum_memory(struct target_s *target, + uint32_t address, uint32_t size, uint32_t* crc); +int target_blank_check_memory(struct target_s *target, + uint32_t address, uint32_t size, uint32_t* blank); +int target_wait_state(target_t *target, enum target_state state, int ms); + +/** Return the *name* of this targets current state */ +const char *target_state_name( target_t *target ); /* DANGER!!!!! * @@ -455,36 +440,38 @@ extern int target_wait_state(target_t *target, enum target_state state, int ms); * upon resuming or resetting the CPU. * */ -extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area); -extern int target_free_working_area(struct target_s *target, working_area_t *area); -extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore); -extern void target_free_all_working_areas(struct target_s *target); -extern void target_free_all_working_areas_restore(struct target_s *target, int restore); +int target_alloc_working_area(struct target_s *target, + uint32_t size, struct working_area **area); +int target_free_working_area(struct target_s *target, struct working_area *area); +int target_free_working_area_restore(struct target_s *target, + struct working_area *area, int restore); +void target_free_all_working_areas(struct target_s *target); +void target_free_all_working_areas_restore(struct target_s *target, int restore); extern target_t *all_targets; -extern target_event_callback_t *target_event_callbacks; -extern target_timer_callback_t *target_timer_callbacks; +extern struct target_event_callback *target_event_callbacks; +extern struct target_timer_callback *target_timer_callbacks; -extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer); -extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer); -extern u8 target_buffer_get_u8 (target_t *target, const u8 *buffer); -extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value); -extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value); -extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value); +uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer); +uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer); +uint8_t target_buffer_get_u8 (target_t *target, const uint8_t *buffer); +void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value); +void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value); +void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t value); -int target_read_u32(struct target_s *target, u32 address, u32 *value); -int target_read_u16(struct target_s *target, u32 address, u16 *value); -int target_read_u8(struct target_s *target, u32 address, u8 *value); -int target_write_u32(struct target_s *target, u32 address, u32 value); -int target_write_u16(struct target_s *target, u32 address, u16 value); -int target_write_u8(struct target_s *target, u32 address, u8 value); +int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value); +int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value); +int target_read_u8(struct target_s *target, uint32_t address, uint8_t *value); +int target_write_u32(struct target_s *target, uint32_t address, uint32_t value); +int target_write_u16(struct target_s *target, uint32_t address, uint16_t value); +int target_write_u8(struct target_s *target, uint32_t address, uint8_t value); /* Issues USER() statements with target state information */ int target_arch_state(struct target_s *target); -void target_handle_event( target_t *t, enum target_event e); -void target_all_handle_event( enum target_event e ); +void target_handle_event(target_t *t, enum target_event e); +void target_all_handle_event(enum target_event e); #define ERROR_TARGET_INVALID (-300) #define ERROR_TARGET_INIT_FAILED (-301) @@ -499,6 +486,7 @@ void target_all_handle_event( enum target_event e ); #define ERROR_TARGET_NOT_EXAMINED (-311) extern const Jim_Nvp nvp_error_target[]; -extern const char *target_strerror_safe( int err ); + +const char *target_strerror_safe(int err); #endif /* TARGET_H */