src/target/target.h

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