src/target/target.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef TARGET_H
  21 #define TARGET_H
  22
  23 #include "register.h"
  24 #include "breakpoints.h"
  25 #include "algorithm.h"
  26 #include "trace.h"
  27
  28 #include "command.h"
  29 #include "types.h"
  30
  31 #include <sys/time.h>
  32 #include <time.h>
  33
  34 struct reg_s;
  35 struct command_context_s;
  36 /*
  37 TARGET_UNKNOWN = 0: we don't know anything about the target yet
  38 TARGET_RUNNING = 1: the target is executing user code
  39 TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  40 debugger. on an xscale it means that the debug handler is executing
  41 TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  42 not sure how this is used with all the recent changes)
  43 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  44 behalf of the debugger (e.g. algorithm for flashing)
  45 */
  46 enum target_state
  47 {
  48         TARGET_UNKNOWN = 0,
  49         TARGET_RUNNING = 1,
  50         TARGET_HALTED = 2,
  51         TARGET_RESET = 3,
  52         TARGET_DEBUG_RUNNING = 4,
  53 };
  54
  55 extern char *target_state_strings[];
  56
  57 enum target_reset_mode
  58 {
  59         RESET_RUN = 0,          /* reset and let target run */
  60         RESET_HALT = 1,         /* reset and halt target out of reset */
  61         RESET_INIT = 2,         /* reset and halt target out of reset, then run init script */
  62         RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
  63         RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
  64 };
  65
  66 enum target_debug_reason
  67 {
  68         DBG_REASON_DBGRQ = 0,
  69         DBG_REASON_BREAKPOINT = 1,
  70         DBG_REASON_WATCHPOINT = 2,
  71         DBG_REASON_WPTANDBKPT = 3,
  72         DBG_REASON_SINGLESTEP = 4,
  73         DBG_REASON_NOTHALTED = 5,
  74         DBG_REASON_UNDEFINED = 6
  75 };
  76
  77 extern char *target_debug_reason_strings[];
  78
  79 enum target_endianess
  80 {
  81         TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
  82 };
  83
  84 extern char *target_endianess_strings[];
  85
  86 struct target_s;
  87
  88 typedef struct working_area_s
  89 {
  90         u32 address;
  91         u32 size;
  92         int free;
  93         u8 *backup;
  94         struct working_area_s **user;
  95         struct working_area_s *next;
  96 } working_area_t;
  97
  98 typedef struct target_type_s
  99 {
 100         char *name;
 101
 102         int examined;
 103
 104         /* poll current target status */
 105         int (*poll)(struct target_s *target);
 106         /* Invoked only from target_arch_state().
 107          * Issue USER() w/architecture specific status.  */
 108         int (*arch_state)(struct target_s *target);
 109
 110         /* target request support */
 111         int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
 112
 113         /* halt will log a warning, but return ERROR_OK if the target is already halted. */
 114         int (*halt)(struct target_s *target);
 115         int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 116         int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
 117
 118         /* target reset control. assert reset can be invoked when OpenOCD and
 119          * the target is out of sync.
 120          *
 121          * A typical example is that the target was power cycled while OpenOCD
 122          * thought the target was halted or running.
 123          *
 124          * assert_reset() can therefore make no assumptions whatsoever about the
 125          * state of the target
 126          *
 127          * Before assert_reset() for the target is invoked, a TRST/tms and
 128          * chain validation is executed. TRST should not be asserted
 129          * during target assert unless there is no way around it due to
 130          * the way reset's are configured.
 131          *
 132          */
 133         int (*assert_reset)(struct target_s *target);
 134         int (*deassert_reset)(struct target_s *target);
 135         int (*soft_reset_halt_imp)(struct target_s *target);
 136         int (*soft_reset_halt)(struct target_s *target);
 137
 138         /* target register access for gdb.
 139          *
 140          * Danger! this function will succeed even if the target is running
 141          * and return a register list with dummy values.
 142          *
 143          * The reason is that GDB connection will fail without a valid register
 144          * list, however it is after GDB is connected that monitor commands can
 145          * be run to properly initialize the target
 146          */
 147         int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
 148
 149         /* target memory access
 150         * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
 151         * count: number of items of <size>
 152         */
 153         int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 154         int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 155         int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 156         int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 157
 158         /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
 159         int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
 160
 161         int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
 162
 163         /* target break-/watchpoint control
 164         * rw: 0 = write, 1 = read, 2 = access
 165         */
 166         int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 167         int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 168         int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 169         int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 170
 171         /* target algorithm support */
 172         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);
 173         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);
 174
 175         int (*register_commands)(struct command_context_s *cmd_ctx);
 176         int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
 177         /* invoked after JTAG chain has been examined & validated. During
 178          * this stage the target is examined and any additional setup is
 179          * performed.
 180          *
 181          * invoked every time after the jtag chain has been validated/examined
 182          */
 183         int (*examine)(struct command_context_s *cmd_ctx, struct target_s *target);
 184         /* Set up structures for target.
 185          *
 186          * It is illegal to talk to the target at this stage as this fn is invoked
 187          * before the JTAG chain has been examined/verified
 188      */
 189         int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
 190         int (*quit)(void);
 191
 192         int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
 193         int (*mmu)(struct target_s *target, int *enabled);
 194
 195 } target_type_t;
 196
 197 typedef struct target_s
 198 {
 199         target_type_t *type;                            /* target type definition (name, access functions) */
 200         enum target_reset_mode reset_mode;      /* what to do after a reset */
 201         int run_and_halt_time;                          /* how long the target should run after a run_and_halt reset */
 202         char *reset_script;                                     /* script file to initialize the target after a reset */
 203         char *post_halt_script;                         /* script file to execute after the target halted */
 204         char *pre_resume_script;                        /* script file to execute before the target resumed */
 205         char *gdb_program_script;                       /* script file to execute before programming vis gdb */
 206         u32 working_area;                                       /* working area (initialized RAM). Evaluated
 207                                                                                    upon first allocation from virtual/physical address.
 208                                                                                   */
 209         u32 working_area_virt;                          /* virtual address */
 210         u32 working_area_phys;                          /* physical address */
 211         u32 working_area_size;                          /* size in bytes */
 212         u32 backup_working_area;                        /* whether the content of the working area has to be preserved */
 213         struct working_area_s *working_areas;/* list of allocated working areas */
 214         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 215         enum target_endianess endianness;       /* target endianess */
 216         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 217         struct reg_cache_s *reg_cache;          /* the first register cache of the target (core regs) */
 218         struct breakpoint_s *breakpoints;       /* list of breakpoints */
 219         struct watchpoint_s *watchpoints;       /* list of watchpoints */
 220         struct trace_s *trace_info;                     /* generic trace information */
 221         struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
 222         u32 dbg_msg_enabled;                            /* debug message status */
 223         void *arch_info;                                        /* architecture specific information */
 224         struct target_s *next;                          /* next target in list */
 225 } target_t;
 226
 227 enum target_event
 228 {
 229         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 230         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 231         TARGET_EVENT_RESET,                     /* target entered reset */
 232         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 233         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 234         TARGET_EVENT_GDB_PROGRAM        /* target about to be be programmed by gdb */
 235 };
 236
 237 typedef struct target_event_callback_s
 238 {
 239         int (*callback)(struct target_s *target, enum target_event event, void *priv);
 240         void *priv;
 241         struct target_event_callback_s *next;
 242 } target_event_callback_t;
 243
 244 typedef struct target_timer_callback_s
 245 {
 246         int (*callback)(void *priv);
 247         int time_ms;
 248         int periodic;
 249         struct timeval when;
 250         void *priv;
 251         struct target_timer_callback_s *next;
 252 } target_timer_callback_t;
 253
 254 extern int target_register_commands(struct command_context_s *cmd_ctx);
 255 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
 256 extern int target_init(struct command_context_s *cmd_ctx);
 257 extern int target_examine(struct command_context_s *cmd_ctx);
 258 extern int handle_target(void *priv);
 259 extern int target_process_reset(struct command_context_s *cmd_ctx);
 260
 261 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 262 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 263 extern int target_poll(target_t *target);
 264 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 265 extern int target_halt(target_t *target);
 266 extern int target_call_event_callbacks(target_t *target, enum target_event event);
 267
 268 /* The period is very approximate, the callback can happen much more often
 269  * or much more rarely than specified
 270  */
 271 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
 272 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 273 extern int target_call_timer_callbacks();
 274 /* invoke this to ensure that e.g. polling timer callbacks happen before
 275  * a syncrhonous command completes.
 276  */
 277 extern int target_call_timer_callbacks_now();
 278
 279 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
 280 extern int get_num_by_target(target_t *query_target);
 281 extern target_t* get_target_by_num(int num);
 282
 283 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 284 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 285 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
 286
 287 /* DANGER!!!!!
 288  *
 289  * if "area" passed in to target_alloc_working_area() points to a memory
 290  * location that goes out of scope (e.g. a pointer on the stack), then
 291  * the caller of target_alloc_working_area() is responsible for invoking
 292  * target_free_working_area() before "area" goes out of scope.
 293  *
 294  * target_free_all_working_areas() will NULL out the "area" pointer
 295  * upon resuming or resetting the CPU.
 296  *
 297  */
 298 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
 299 extern int target_free_working_area(struct target_s *target, working_area_t *area);
 300 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
 301 extern int target_free_all_working_areas(struct target_s *target);
 302 extern int target_free_all_working_areas_restore(struct target_s *target, int restore);
 303
 304
 305 extern target_t *targets;
 306
 307 extern target_event_callback_t *target_event_callbacks;
 308 extern target_timer_callback_t *target_timer_callbacks;
 309
 310 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
 311 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
 312 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
 313 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
 314
 315 int target_read_u32(struct target_s *target, u32 address, u32 *value);
 316 int target_read_u16(struct target_s *target, u32 address, u16 *value);
 317 int target_read_u8(struct target_s *target, u32 address, u8 *value);
 318 int target_write_u32(struct target_s *target, u32 address, u32 value);
 319 int target_write_u16(struct target_s *target, u32 address, u16 value);
 320 int target_write_u8(struct target_s *target, u32 address, u8 value);
 321
 322 /* Issues USER() statements with target state information */
 323 int target_arch_state(struct target_s *target);
 324
 325 #define ERROR_TARGET_INVALID    (-300)
 326 #define ERROR_TARGET_INIT_FAILED (-301)
 327 #define ERROR_TARGET_TIMEOUT    (-302)
 328 #define ERROR_TARGET_NOT_HALTED (-304)
 329 #define ERROR_TARGET_FAILURE    (-305)
 330 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 331 #define ERROR_TARGET_DATA_ABORT (-307)
 332 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 333 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 334 #define ERROR_TARGET_NOT_RUNNING (-310)
 335
 336 #endif /* TARGET_H */