X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=src%2Ftarget%2Ftarget.h;h=9674c473c150409869c4bb6a82ca964329721685;hb=11edf227768f41b2a96c0d26a871f9e5f89d259a;hp=c6f6beddc12f8bdced3842f14bbbbd7033e70014;hpb=ef1cfb23947bd32798077c6abb5c25a049460ae9;p=fw%2Fopenocd diff --git a/src/target/target.h b/src/target/target.h index c6f6beddc..9674c473c 100644 --- a/src/target/target.h +++ b/src/target/target.h @@ -2,9 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008 Øyvind Harboe * * oyvind.harboe@zylin.com * * * + * Copyright (C) 2008 by Spencer Oliver * + * spen@spen-soft.co.uk * + * * * 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 * @@ -23,29 +26,24 @@ #ifndef TARGET_H #define TARGET_H -#include "register.h" #include "breakpoints.h" #include "algorithm.h" -#include "trace.h" - #include "command.h" -#include "types.h" - -#include -#include struct reg_s; +struct trace_s; struct command_context_s; + /* -TARGET_UNKNOWN = 0: we don't know anything about the target yet -TARGET_RUNNING = 1: the target is executing user code -TARGET_HALTED = 2: the target is not executing code, and ready to talk to the -debugger. on an xscale it means that the debug handler is executing -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) -*/ + * TARGET_UNKNOWN = 0: we don't know anything about the target yet + * TARGET_RUNNING = 1: the target is executing user code + * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the + * debugger. on an xscale it means that the debug handler is executing + * 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) */ + enum target_state { TARGET_UNKNOWN = 0, @@ -110,7 +108,13 @@ typedef struct working_area_s 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 */ @@ -126,66 +130,78 @@ typedef struct target_type_s 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 - * + * 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 + + /* 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 byte, optimized for writing large quantities of data */ + + /** + * 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 + + /* + * 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. */ @@ -198,9 +214,13 @@ typedef struct target_type_s /* 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); + int (*register_commands)(struct command_context_s *cmd_ctx); /* called when target is created */ int (*target_create)( struct target_s *target, Jim_Interp *interp ); @@ -217,39 +237,38 @@ typedef struct target_type_s /* 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); - + } target_type_t; -// forward decloration +/* forward decloration */ typedef struct target_event_action_s target_event_action_t; 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 */ - int chain_position; /* where on the jtag chain is this */ - const char *variant; /* what varient of this chip is it? */ - enum target_reset_mode reset_mode; /* how should this target be reset */ + 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 */ + 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 - upon first allocation from virtual/physical address. */ + u32 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 */ @@ -266,24 +285,34 @@ typedef struct target_s u32 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. */ } target_t; enum target_event { - // OLD historical names - // - Prior to the great TCL change - // - June/July/Aug 2008 - // - Duane Ellis + /* 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_reset, TARGET_EVENT_OLD_post_reset, TARGET_EVENT_OLD_pre_resume, - TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */ - TARGET_EVENT_RESUMED, /* target resumed to normal execution */ + /* 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, + TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */ + TARGET_EVENT_RESUMED, /* target resumed to normal execution */ TARGET_EVENT_RESUME_START, TARGET_EVENT_RESUME_END, + TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */ + TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */ + TARGET_EVENT_RESET_START, TARGET_EVENT_RESET_ASSERT_PRE, TARGET_EVENT_RESET_ASSERT_POST, @@ -296,13 +325,11 @@ enum target_event TARGET_EVENT_RESET_INIT, TARGET_EVENT_RESET_END, - - TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */ - TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */ + TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */ + TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */ TARGET_EVENT_EXAMINE_START, TARGET_EVENT_EXAMINE_END, - TARGET_EVENT_GDB_ATTACH, TARGET_EVENT_GDB_DETACH, @@ -313,12 +340,10 @@ enum target_event TARGET_EVENT_GDB_FLASH_WRITE_END, }; -extern const Jim_Nvp nvp_target_event[]; - struct target_event_action_s { enum target_event event; Jim_Obj *body; - int has_percent; + int has_percent; target_event_action_t *next; }; @@ -353,7 +378,7 @@ extern int target_resume(target_t *target, int current, u32 address, int handle_ 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 +/* 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); @@ -366,7 +391,52 @@ extern int target_call_timer_callbacks_now(void); 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_by_num(int num); +extern target_t *get_target(const char *id); + +/// @returns @c true if the target has been examined. +extern 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); +/// Reset the @c examined flag for the given target. +extern void target_reset_examined(struct target_s *target); + +/** + * 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 timeout_ms, void *arch_info); + +/** + * Read @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); +/** + * Write @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); + +/** + * Write @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); 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); @@ -375,30 +445,30 @@ extern int target_blank_check_memory(struct target_s *target, u32 address, u32 s extern int target_wait_state(target_t *target, enum target_state state, int ms); /* DANGER!!!!! - * + * * if "area" passed in to target_alloc_working_area() points to a memory * location that goes out of scope (e.g. a pointer on the stack), then * the caller of target_alloc_working_area() is responsible for invoking * target_free_working_area() before "area" goes out of scope. - * + * * target_free_all_working_areas() will NULL out the "area" pointer * 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 int target_free_all_working_areas(struct target_s *target); -extern int target_free_all_working_areas_restore(struct target_s *target, 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); extern target_t *all_targets; extern target_event_callback_t *target_event_callbacks; extern target_timer_callback_t *target_timer_callbacks; -extern u32 target_buffer_get_u32(target_t *target, u8 *buffer); -extern u16 target_buffer_get_u16(target_t *target, u8 *buffer); -extern u8 target_buffer_get_u8 (target_t *target, u8 *buffer); +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); @@ -416,7 +486,6 @@ 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 ); - #define ERROR_TARGET_INVALID (-300) #define ERROR_TARGET_INIT_FAILED (-301) #define ERROR_TARGET_TIMEOUT (-302) @@ -433,11 +502,3 @@ extern const Jim_Nvp nvp_error_target[]; extern const char *target_strerror_safe( int err ); #endif /* TARGET_H */ - - -/* - * Local Variables: *** - * c-basic-offset: 4 *** - * tab-width: 4 *** - * End: *** - */