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  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef TARGET_H
  27 #define TARGET_H
  28
  29 #include "breakpoints.h"
  30 #include "algorithm.h"
  31 #include "command.h"
  32
  33 struct reg_s;
  34 struct trace_s;
  35 struct command_context_s;
  36
  37 /*
  38  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
  39  * TARGET_RUNNING = 1: the target is executing user code
  40  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  41  * debugger. on an xscale it means that the debug handler is executing
  42  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  43  * not sure how this is used with all the recent changes)
  44  * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  45  * behalf of the debugger (e.g. algorithm for flashing) */
  46
  47 enum target_state
  48 {
  49         TARGET_UNKNOWN = 0,
  50         TARGET_RUNNING = 1,
  51         TARGET_HALTED = 2,
  52         TARGET_RESET = 3,
  53         TARGET_DEBUG_RUNNING = 4,
  54 };
  55
  56 extern const Jim_Nvp nvp_target_state[];
  57
  58 enum nvp_assert {
  59         NVP_DEASSERT,
  60         NVP_ASSERT,
  61 };
  62
  63 extern const Jim_Nvp nvp_assert[];
  64
  65 enum target_reset_mode
  66 {
  67         RESET_UNKNOWN = 0,
  68         RESET_RUN = 1,          /* reset and let target run */
  69         RESET_HALT = 2,         /* reset and halt target out of reset */
  70         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
  71 };
  72
  73 extern const Jim_Nvp nvp_reset_mode[];
  74
  75 enum target_debug_reason
  76 {
  77         DBG_REASON_DBGRQ = 0,
  78         DBG_REASON_BREAKPOINT = 1,
  79         DBG_REASON_WATCHPOINT = 2,
  80         DBG_REASON_WPTANDBKPT = 3,
  81         DBG_REASON_SINGLESTEP = 4,
  82         DBG_REASON_NOTHALTED = 5,
  83         DBG_REASON_UNDEFINED = 6
  84 };
  85
  86 extern const Jim_Nvp nvp_target_debug_reason[];
  87
  88 enum target_endianess
  89 {
  90         TARGET_ENDIAN_UNKNOWN=0,
  91         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
  92 };
  93
  94 extern const Jim_Nvp nvp_target_endian[];
  95
  96 struct target_s;
  97
  98 typedef struct working_area_s
  99 {
 100         u32 address;
 101         u32 size;
 102         int free;
 103         u8 *backup;
 104         struct working_area_s **user;
 105         struct working_area_s *next;
 106 } working_area_t;
 107
 108 typedef struct target_type_s
 109 {
 110         char *name;
 111
 112         int examined;
 113
 114         /* poll current target status */
 115         int (*poll)(struct target_s *target);
 116         /* Invoked only from target_arch_state().
 117          * Issue USER() w/architecture specific status.  */
 118         int (*arch_state)(struct target_s *target);
 119
 120         /* target request support */
 121         int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
 122
 123         /* halt will log a warning, but return ERROR_OK if the target is already halted. */
 124         int (*halt)(struct target_s *target);
 125         int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 126         int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
 127
 128         /* target reset control. assert reset can be invoked when OpenOCD and
 129          * the target is out of sync.
 130          *
 131          * A typical example is that the target was power cycled while OpenOCD
 132          * thought the target was halted or running.
 133          *
 134          * assert_reset() can therefore make no assumptions whatsoever about the
 135          * state of the target
 136          *
 137          * Before assert_reset() for the target is invoked, a TRST/tms and
 138          * chain validation is executed. TRST should not be asserted
 139          * during target assert unless there is no way around it due to
 140          * the way reset's are configured.
 141          *
 142          */
 143         int (*assert_reset)(struct target_s *target);
 144         int (*deassert_reset)(struct target_s *target);
 145         int (*soft_reset_halt_imp)(struct target_s *target);
 146         int (*soft_reset_halt)(struct target_s *target);
 147
 148         /* target register access for gdb.
 149          *
 150          * Danger! this function will succeed even if the target is running
 151          * and return a register list with dummy values.
 152          *
 153          * The reason is that GDB connection will fail without a valid register
 154          * list, however it is after GDB is connected that monitor commands can
 155          * be run to properly initialize the target
 156          */
 157         int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
 158
 159         /* target memory access
 160         * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
 161         * count: number of items of <size>
 162         */
 163         int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 164         /**
 165          * Target memory read callback.  Do @b not call this function
 166          * directly, use target_read_memory() instead.
 167          */
 168         int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 169         int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 170         /**
 171          * Target memory write callback.  Do @b not call this function
 172          * directly, use target_write_memory() instead.
 173          */
 174         int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 175
 176         /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
 177         int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
 178
 179         int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
 180         int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
 181
 182         /*
 183          * target break-/watchpoint control
 184          * rw: 0 = write, 1 = read, 2 = access
 185          *
 186          * Target must be halted while this is invoked as this
 187          * will actually set up breakpoints on target.
 188          *
 189          * The breakpoint hardware will be set up upon adding the first breakpoint.
 190          *
 191          * Upon GDB connection all breakpoints/watchpoints are cleared.
 192          */
 193         int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 194
 195         /* remove breakpoint. hw will only be updated if the target is currently halted.
 196          * However, this method can be invoked on unresponsive targets.
 197          */
 198         int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 199         int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 200         /* remove watchpoint. hw will only be updated if the target is currently halted.
 201          * However, this method can be invoked on unresponsive targets.
 202          */
 203         int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 204
 205         /* target algorithm support */
 206         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);
 207         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);
 208
 209         int (*register_commands)(struct command_context_s *cmd_ctx);
 210
 211         /* called when target is created */
 212         int (*target_create)( struct target_s *target, Jim_Interp *interp );
 213
 214         /* called for various config parameters */
 215         /* returns JIM_CONTINUE - if option not understood */
 216         /* otherwise: JIM_OK, or JIM_ERR, */
 217         int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
 218
 219         /* target commands specifically handled by the target */
 220         /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
 221         int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
 222
 223         /* invoked after JTAG chain has been examined & validated. During
 224          * this stage the target is examined and any additional setup is
 225          * performed.
 226          *
 227          * invoked every time after the jtag chain has been validated/examined
 228          */
 229         int (*examine)(struct target_s *target);
 230         /* Set up structures for target.
 231          *
 232          * It is illegal to talk to the target at this stage as this fn is invoked
 233          * before the JTAG chain has been examined/verified
 234          * */
 235         int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
 236         int (*quit)(void);
 237
 238         int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
 239         int (*mmu)(struct target_s *target, int *enabled);
 240
 241 } target_type_t;
 242
 243 /* forward decloration */
 244 typedef struct target_event_action_s target_event_action_t;
 245
 246 typedef struct target_s
 247 {
 248         target_type_t *type;                            /* target type definition (name, access functions) */
 249         const char *cmd_name;                           /* tcl Name of target */
 250         int target_number;                                      /* generaly, target index but may not be in order */
 251         jtag_tap_t *tap;                                        /* where on the jtag chain is this */
 252         const char *variant;                            /* what varient of this chip is it? */
 253         target_event_action_t *event_action;
 254
 255         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
 256         u32 working_area;                                       /* working area (initialized RAM). Evaluated
 257                                                                                  * upon first allocation from virtual/physical address. */
 258         u32 working_area_virt;                          /* virtual address */
 259         u32 working_area_phys;                          /* physical address */
 260         u32 working_area_size;                          /* size in bytes */
 261         u32 backup_working_area;                        /* whether the content of the working area has to be preserved */
 262         struct working_area_s *working_areas;/* list of allocated working areas */
 263         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 264         enum target_endianess endianness;       /* target endianess */
 265         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 266         struct reg_cache_s *reg_cache;          /* the first register cache of the target (core regs) */
 267         struct breakpoint_s *breakpoints;       /* list of breakpoints */
 268         struct watchpoint_s *watchpoints;       /* list of watchpoints */
 269         struct trace_s *trace_info;                     /* generic trace information */
 270         struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
 271         u32 dbg_msg_enabled;                            /* debug message status */
 272         void *arch_info;                                        /* architecture specific information */
 273         struct target_s *next;                          /* next target in list */
 274
 275         int display;                                            /* display async info in telnet session. Do not display
 276                                                                                  * lots of halted/resumed info when stepping in debugger. */
 277 } target_t;
 278
 279 enum target_event
 280 {
 281         /* LD historical names
 282          * - Prior to the great TCL change
 283          * - June/July/Aug 2008
 284          * - Duane Ellis */
 285         TARGET_EVENT_OLD_gdb_program_config,
 286         TARGET_EVENT_OLD_pre_reset,
 287         TARGET_EVENT_OLD_post_reset,
 288         TARGET_EVENT_OLD_pre_resume,
 289
 290         /* allow GDB to do stuff before others handle the halted event,
 291          * this is in lieu of defining ordering of invocation of events,
 292          * which would be more complicated */
 293         TARGET_EVENT_EARLY_HALTED,
 294         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 295         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 296         TARGET_EVENT_RESUME_START,
 297         TARGET_EVENT_RESUME_END,
 298
 299         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 300         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 301
 302         TARGET_EVENT_RESET_START,
 303         TARGET_EVENT_RESET_ASSERT_PRE,
 304         TARGET_EVENT_RESET_ASSERT_POST,
 305         TARGET_EVENT_RESET_DEASSERT_PRE,
 306         TARGET_EVENT_RESET_DEASSERT_POST,
 307         TARGET_EVENT_RESET_HALT_PRE,
 308         TARGET_EVENT_RESET_HALT_POST,
 309         TARGET_EVENT_RESET_WAIT_PRE,
 310         TARGET_EVENT_RESET_WAIT_POST,
 311         TARGET_EVENT_RESET_INIT,
 312         TARGET_EVENT_RESET_END,
 313
 314         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 315         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 316
 317         TARGET_EVENT_EXAMINE_START,
 318         TARGET_EVENT_EXAMINE_END,
 319
 320         TARGET_EVENT_GDB_ATTACH,
 321         TARGET_EVENT_GDB_DETACH,
 322
 323         TARGET_EVENT_GDB_FLASH_ERASE_START,
 324         TARGET_EVENT_GDB_FLASH_ERASE_END,
 325         TARGET_EVENT_GDB_FLASH_WRITE_START,
 326         TARGET_EVENT_GDB_FLASH_WRITE_END,
 327 };
 328
 329 struct target_event_action_s {
 330         enum target_event event;
 331         Jim_Obj *body;
 332         int has_percent;
 333         target_event_action_t *next;
 334  };
 335
 336 typedef struct target_event_callback_s
 337 {
 338         int (*callback)(struct target_s *target, enum target_event event, void *priv);
 339         void *priv;
 340         struct target_event_callback_s *next;
 341 } target_event_callback_t;
 342
 343 typedef struct target_timer_callback_s
 344 {
 345         int (*callback)(void *priv);
 346         int time_ms;
 347         int periodic;
 348         struct timeval when;
 349         void *priv;
 350         struct target_timer_callback_s *next;
 351 } target_timer_callback_t;
 352
 353 extern int target_register_commands(struct command_context_s *cmd_ctx);
 354 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
 355 extern int target_init(struct command_context_s *cmd_ctx);
 356 extern int target_examine(void);
 357 extern int handle_target(void *priv);
 358 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
 359
 360 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 361 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 362 extern int target_poll(target_t *target);
 363 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 364 extern int target_halt(target_t *target);
 365 extern int target_call_event_callbacks(target_t *target, enum target_event event);
 366
 367 /* The period is very approximate, the callback can happen much more often
 368  * or much more rarely than specified
 369  */
 370 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
 371 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 372 extern int target_call_timer_callbacks(void);
 373 /* invoke this to ensure that e.g. polling timer callbacks happen before
 374  * a syncrhonous command completes.
 375  */
 376 extern int target_call_timer_callbacks_now(void);
 377
 378 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
 379 extern int get_num_by_target(target_t *query_target);
 380 extern target_t *get_target(const char *id);
 381
 382 /**
 383  * Read @count items of @a size bytes from the memory of @a target at
 384  * the @a address given.
 385  *
 386  * This routine is a wrapper for target->type->read_memory.
 387  */
 388 extern int target_read_memory(struct target_s *target,
 389                 u32 address, u32 size, u32 count, u8 *buffer);
 390 /**
 391  * Write @count items of @a size bytes to the memory of @a target at
 392  * the @a address given.
 393  *
 394  * This routine is wrapper for target->type->write_memory.
 395  */
 396 extern int target_write_memory(struct target_s *target,
 397                 u32 address, u32 size, u32 count, u8 *buffer);
 398
 399 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 400 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 401 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
 402 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
 403 extern int target_wait_state(target_t *target, enum target_state state, int ms);
 404
 405 /* DANGER!!!!!
 406  *
 407  * if "area" passed in to target_alloc_working_area() points to a memory
 408  * location that goes out of scope (e.g. a pointer on the stack), then
 409  * the caller of target_alloc_working_area() is responsible for invoking
 410  * target_free_working_area() before "area" goes out of scope.
 411  *
 412  * target_free_all_working_areas() will NULL out the "area" pointer
 413  * upon resuming or resetting the CPU.
 414  *
 415  */
 416 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
 417 extern int target_free_working_area(struct target_s *target, working_area_t *area);
 418 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
 419 extern void target_free_all_working_areas(struct target_s *target);
 420 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
 421
 422 extern target_t *all_targets;
 423
 424 extern target_event_callback_t *target_event_callbacks;
 425 extern target_timer_callback_t *target_timer_callbacks;
 426
 427 extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
 428 extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
 429 extern u8  target_buffer_get_u8 (target_t *target, const u8 *buffer);
 430 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
 431 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
 432 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8  value);
 433
 434 int target_read_u32(struct target_s *target, u32 address, u32 *value);
 435 int target_read_u16(struct target_s *target, u32 address, u16 *value);
 436 int target_read_u8(struct target_s *target, u32 address, u8 *value);
 437 int target_write_u32(struct target_s *target, u32 address, u32 value);
 438 int target_write_u16(struct target_s *target, u32 address, u16 value);
 439 int target_write_u8(struct target_s *target, u32 address, u8 value);
 440
 441 /* Issues USER() statements with target state information */
 442 int target_arch_state(struct target_s *target);
 443
 444 void target_handle_event( target_t *t, enum target_event e);
 445 void target_all_handle_event( enum target_event e );
 446
 447 #define ERROR_TARGET_INVALID    (-300)
 448 #define ERROR_TARGET_INIT_FAILED (-301)
 449 #define ERROR_TARGET_TIMEOUT    (-302)
 450 #define ERROR_TARGET_NOT_HALTED (-304)
 451 #define ERROR_TARGET_FAILURE    (-305)
 452 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 453 #define ERROR_TARGET_DATA_ABORT (-307)
 454 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 455 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 456 #define ERROR_TARGET_NOT_RUNNING (-310)
 457 #define ERROR_TARGET_NOT_EXAMINED (-311)
 458
 459 extern const Jim_Nvp nvp_error_target[];
 460 extern const char *target_strerror_safe( int err );
 461
 462 #endif /* TARGET_H */