X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Ftarget%2Ftarget.h;h=500a55198b38b42f5ff6e30793b2139ffc7d2ea3;hb=cb3f970b6c61d0643839f9261ddcce2b8664eac7;hp=f6f5177e63d68158505b4cd786a040f2a4ea38cf;hpb=5ac8036b7fdaa32d44fb756f46f60d8de33e3a50;p=openocd.git diff --git a/src/target/target.h b/src/target/target.h index f6f5177e63..500a55198b 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 * @@ -37,15 +40,15 @@ struct reg_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 +113,7 @@ typedef struct working_area_s typedef struct target_type_s { char *name; - + int examined; /* poll current target status */ @@ -126,39 +129,39 @@ 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 */ @@ -166,26 +169,26 @@ typedef struct target_type_s 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); 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 */ 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. */ @@ -200,7 +203,7 @@ typedef struct target_type_s 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); 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,38 +220,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? */ + 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 */ @@ -265,24 +268,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, @@ -295,13 +308,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, @@ -317,7 +328,7 @@ 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; }; @@ -352,7 +363,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); @@ -374,21 +385,21 @@ 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; @@ -415,7 +426,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) @@ -432,11 +442,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: *** - */