src/target/target.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008,2009 Ø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 "types.h"
  30 #include "jim.h"
  31
  32 struct reg;
  33 struct trace;
  34 struct command_context;
  35 struct breakpoint;
  36 struct watchpoint;
  37 struct mem_param;
  38 struct reg_param;
  39
  40
  41 /*
  42  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
  43  * TARGET_RUNNING = 1: the target is executing user code
  44  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  45  * debugger. on an xscale it means that the debug handler is executing
  46  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  47  * not sure how this is used with all the recent changes)
  48  * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  49  * behalf of the debugger (e.g. algorithm for flashing)
  50  *
  51  * also see: target_state_name();
  52  */
  53
  54
  55 enum target_state
  56 {
  57         TARGET_UNKNOWN = 0,
  58         TARGET_RUNNING = 1,
  59         TARGET_HALTED = 2,
  60         TARGET_RESET = 3,
  61         TARGET_DEBUG_RUNNING = 4,
  62 };
  63
  64 extern const Jim_Nvp nvp_target_state[];
  65
  66 enum nvp_assert {
  67         NVP_DEASSERT,
  68         NVP_ASSERT,
  69 };
  70
  71 extern const Jim_Nvp nvp_assert[];
  72
  73 enum target_reset_mode
  74 {
  75         RESET_UNKNOWN = 0,
  76         RESET_RUN = 1,          /* reset and let target run */
  77         RESET_HALT = 2,         /* reset and halt target out of reset */
  78         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
  79 };
  80
  81 extern const Jim_Nvp nvp_reset_mode[];
  82
  83 enum target_debug_reason
  84 {
  85         DBG_REASON_DBGRQ = 0,
  86         DBG_REASON_BREAKPOINT = 1,
  87         DBG_REASON_WATCHPOINT = 2,
  88         DBG_REASON_WPTANDBKPT = 3,
  89         DBG_REASON_SINGLESTEP = 4,
  90         DBG_REASON_NOTHALTED = 5,
  91         DBG_REASON_UNDEFINED = 6
  92 };
  93
  94 extern const Jim_Nvp nvp_target_debug_reason[];
  95
  96 enum target_endianess
  97 {
  98         TARGET_ENDIAN_UNKNOWN = 0,
  99         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
 100 };
 101
 102 extern const Jim_Nvp nvp_target_endian[];
 103
 104 struct working_area
 105 {
 106         uint32_t address;
 107         uint32_t size;
 108         int free;
 109         uint8_t *backup;
 110         struct working_area **user;
 111         struct working_area *next;
 112 };
 113
 114 // target_type.h contains the full definitionof struct targe_type
 115 struct target
 116 {
 117         struct target_type *type;                               /* target type definition (name, access functions) */
 118         const char *cmd_name;                           /* tcl Name of target */
 119         int target_number;                                      /* DO NOT USE!  field to be removed in 2010 */
 120         struct jtag_tap *tap;                                   /* where on the jtag chain is this */
 121         const char *variant;                            /* what variant of this chip is it? */
 122
 123         /**
 124          * Indicates whether this target has been examined.
 125          *
 126          * Do @b not access this field directly, use target_was_examined()
 127          * or target_set_examined().
 128          */
 129         bool examined;
 130
 131         struct target_event_action *event_action;
 132
 133         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
 134         uint32_t working_area;                                  /* working area (initialized RAM). Evaluated
 135                                                                                  * upon first allocation from virtual/physical address. */
 136         bool working_area_virt_spec;            /* virtual address specified? */
 137         uint32_t working_area_virt;                     /* virtual address */
 138         bool working_area_phys_spec;            /* virtual address specified? */
 139         uint32_t working_area_phys;                     /* physical address */
 140         uint32_t working_area_size;                     /* size in bytes */
 141         uint32_t backup_working_area;                   /* whether the content of the working area has to be preserved */
 142         struct working_area *working_areas;/* list of allocated working areas */
 143         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 144         enum target_endianess endianness;       /* target endianess */
 145         // also see: target_state_name()
 146         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 147         struct reg_cache *reg_cache;            /* the first register cache of the target (core regs) */
 148         struct breakpoint *breakpoints; /* list of breakpoints */
 149         struct watchpoint *watchpoints; /* list of watchpoints */
 150         struct trace *trace_info;                       /* generic trace information */
 151         struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
 152         uint32_t dbg_msg_enabled;                               /* debug message status */
 153         void *arch_info;                                        /* architecture specific information */
 154         struct target *next;                            /* next target in list */
 155
 156         int display;                                            /* display async info in telnet session. Do not display
 157                                                                                  * lots of halted/resumed info when stepping in debugger. */
 158         bool halt_issued;                                       /* did we transition to halted state? */
 159         long long halt_issued_time;                     /* Note time when halt was issued */
 160 };
 161
 162 /** Returns the instance-specific name of the specified target. */
 163 static inline const char *target_name(struct target *target)
 164 {
 165         return target->cmd_name;
 166 }
 167
 168 enum target_event
 169 {
 170         /* LD historical names
 171          * - Prior to the great TCL change
 172          * - June/July/Aug 2008
 173          * - Duane Ellis */
 174         TARGET_EVENT_OLD_gdb_program_config,
 175         TARGET_EVENT_OLD_pre_reset,
 176         TARGET_EVENT_OLD_post_reset,
 177         TARGET_EVENT_OLD_pre_resume,
 178
 179         /* allow GDB to do stuff before others handle the halted event,
 180          * this is in lieu of defining ordering of invocation of events,
 181          * which would be more complicated
 182          *
 183          * Telling GDB to halt does not mean that the target stopped running,
 184          * simply that we're dropping out of GDB's waiting for step or continue.
 185          *
 186          * This can be useful when e.g. detecting power dropout.
 187          */
 188         TARGET_EVENT_GDB_HALT,
 189         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 190         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 191         TARGET_EVENT_RESUME_START,
 192         TARGET_EVENT_RESUME_END,
 193
 194         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 195         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 196
 197         TARGET_EVENT_RESET_START,
 198         TARGET_EVENT_RESET_ASSERT_PRE,
 199         TARGET_EVENT_RESET_ASSERT_POST,
 200         TARGET_EVENT_RESET_DEASSERT_PRE,
 201         TARGET_EVENT_RESET_DEASSERT_POST,
 202         TARGET_EVENT_RESET_HALT_PRE,
 203         TARGET_EVENT_RESET_HALT_POST,
 204         TARGET_EVENT_RESET_WAIT_PRE,
 205         TARGET_EVENT_RESET_WAIT_POST,
 206         TARGET_EVENT_RESET_INIT,
 207         TARGET_EVENT_RESET_END,
 208
 209         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 210         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 211
 212         TARGET_EVENT_EXAMINE_START,
 213         TARGET_EVENT_EXAMINE_END,
 214
 215         TARGET_EVENT_GDB_ATTACH,
 216         TARGET_EVENT_GDB_DETACH,
 217
 218         TARGET_EVENT_GDB_FLASH_ERASE_START,
 219         TARGET_EVENT_GDB_FLASH_ERASE_END,
 220         TARGET_EVENT_GDB_FLASH_WRITE_START,
 221         TARGET_EVENT_GDB_FLASH_WRITE_END,
 222 };
 223
 224 struct target_event_action {
 225         enum target_event event;
 226         struct Jim_Obj *body;
 227         int has_percent;
 228         struct target_event_action *next;
 229  };
 230
 231 struct target_event_callback
 232 {
 233         int (*callback)(struct target *target, enum target_event event, void *priv);
 234         void *priv;
 235         struct target_event_callback *next;
 236 };
 237
 238 struct target_timer_callback
 239 {
 240         int (*callback)(void *priv);
 241         int time_ms;
 242         int periodic;
 243         struct timeval when;
 244         void *priv;
 245         struct target_timer_callback *next;
 246 };
 247
 248 int target_register_commands(struct command_context *cmd_ctx);
 249 int target_register_user_commands(struct command_context *cmd_ctx);
 250 int target_init(struct command_context *cmd_ctx);
 251 int target_examine(void);
 252 int handle_target(void *priv);
 253 int target_process_reset(struct command_context *cmd_ctx,
 254                 enum target_reset_mode reset_mode);
 255
 256 int target_register_event_callback(
 257                 int (*callback)(struct target *target,
 258                                 enum target_event event, void *priv),
 259                 void *priv);
 260 int target_unregister_event_callback(
 261                 int (*callback)(struct target *target,
 262                                 enum target_event event, void *priv),
 263                 void *priv);
 264 int target_poll(struct target *target);
 265 int target_resume(struct target *target, int current, uint32_t address,
 266                 int handle_breakpoints, int debug_execution);
 267 int target_halt(struct target *target);
 268 int target_call_event_callbacks(struct target *target, enum target_event event);
 269
 270 /**
 271  * The period is very approximate, the callback can happen much more often
 272  * or much more rarely than specified
 273  */
 274 int target_register_timer_callback(int (*callback)(void *priv),
 275                 int time_ms, int periodic, void *priv);
 276 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 277
 278 int target_call_timer_callbacks(void);
 279 /**
 280  * Invoke this to ensure that e.g. polling timer callbacks happen before
 281  * a syncrhonous command completes.
 282  */
 283 int target_call_timer_callbacks_now(void);
 284
 285 struct target* get_current_target(struct command_context *cmd_ctx);
 286 struct target *get_target(const char *id);
 287
 288 /**
 289  * Get the target type name.
 290  *
 291  * This routine is a wrapper for the target->type->name field.
 292  * Note that this is not an instance-specific name for his target.
 293  */
 294 const char *target_type_name(struct target *target);
 295
 296 /**
 297  * Examine the specified @a target, letting it perform any
 298  * initialization that requires JTAG access.
 299  *
 300  * This routine is a wrapper for target->type->examine.
 301  */
 302 int target_examine_one(struct target *target);
 303
 304 /// @returns @c true if target_set_examined() has been called.
 305 static inline bool target_was_examined(struct target *target)
 306 {
 307         return target->examined;
 308 }
 309
 310 /// Sets the @c examined flag for the given target.
 311 /// Use in target->type->examine() after one-time setup is done.
 312 static inline void target_set_examined(struct target *target)
 313 {
 314         target->examined = true;
 315 }
 316
 317 /**
 318  * Add the @a breakpoint for @a target.
 319  *
 320  * This routine is a wrapper for target->type->add_breakpoint.
 321  */
 322 int target_add_breakpoint(struct target *target,
 323                 struct breakpoint *breakpoint);
 324 /**
 325  * Remove the @a breakpoint for @a target.
 326  *
 327  * This routine is a wrapper for target->type->remove_breakpoint.
 328  */
 329 int target_remove_breakpoint(struct target *target,
 330                 struct breakpoint *breakpoint);
 331 /**
 332  * Add the @a watchpoint for @a target.
 333  *
 334  * This routine is a wrapper for target->type->add_watchpoint.
 335  */
 336 int target_add_watchpoint(struct target *target,
 337                 struct watchpoint *watchpoint);
 338 /**
 339  * Remove the @a watchpoint for @a target.
 340  *
 341  * This routine is a wrapper for target->type->remove_watchpoint.
 342  */
 343 int target_remove_watchpoint(struct target *target,
 344                 struct watchpoint *watchpoint);
 345
 346 /**
 347  * Obtain the registers for GDB.
 348  *
 349  * This routine is a wrapper for target->type->get_gdb_reg_list.
 350  */
 351 int target_get_gdb_reg_list(struct target *target,
 352                 struct reg **reg_list[], int *reg_list_size);
 353
 354 /**
 355  * Step the target.
 356  *
 357  * This routine is a wrapper for target->type->step.
 358  */
 359 int target_step(struct target *target,
 360                 int current, uint32_t address, int handle_breakpoints);
 361 /**
 362  * Run an algorithm on the @a target given.
 363  *
 364  * This routine is a wrapper for target->type->run_algorithm.
 365  */
 366 int target_run_algorithm(struct target *target,
 367                 int num_mem_params, struct mem_param *mem_params,
 368                 int num_reg_params, struct reg_param *reg_param,
 369                 uint32_t entry_point, uint32_t exit_point,
 370                 int timeout_ms, void *arch_info);
 371
 372 /**
 373  * Read @a count items of @a size bytes from the memory of @a target at
 374  * the @a address given.
 375  *
 376  * This routine is a wrapper for target->type->read_memory.
 377  */
 378 int target_read_memory(struct target *target,
 379                 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 380 /**
 381  * Write @a count items of @a size bytes to the memory of @a target at
 382  * the @a address given.
 383  *
 384  * This routine is wrapper for target->type->write_memory.
 385  */
 386 int target_write_memory(struct target *target,
 387                 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 388
 389 /**
 390  * Write @a count items of 4 bytes to the memory of @a target at
 391  * the @a address given.  Because it operates only on whole words,
 392  * this should be faster than target_write_memory().
 393  *
 394  * This routine is wrapper for target->type->bulk_write_memory.
 395  */
 396 int target_bulk_write_memory(struct target *target,
 397                 uint32_t address, uint32_t count, uint8_t *buffer);
 398
 399 /*
 400  * Write to target memory using the virtual address.
 401  *
 402  * Note that this fn is used to implement software breakpoints. Targets
 403  * can implement support for software breakpoints to memory marked as read
 404  * only by making this fn write to ram even if it is read only(MMU or
 405  * MPUs).
 406  *
 407  * It is sufficient to implement for writing a single word(16 or 32 in
 408  * ARM32/16 bit case) to write the breakpoint to ram.
 409  *
 410  * The target should also take care of "other things" to make sure that
 411  * software breakpoints can be written using this function. E.g.
 412  * when there is a separate instruction and data cache, this fn must
 413  * make sure that the instruction cache is synced up to the potential
 414  * code change that can happen as a result of the memory write(typically
 415  * by invalidating the cache).
 416  *
 417  * The high level wrapper fn in target.c will break down this memory write
 418  * request to multiple write requests to the target driver to e.g. guarantee
 419  * that writing 4 bytes to an aligned address happens with a single 32 bit
 420  * write operation, thus making this fn suitable to e.g. write to special
 421  * peripheral registers which do not support byte operations.
 422  */
 423 int target_write_buffer(struct target *target,
 424                 uint32_t address, uint32_t size, uint8_t *buffer);
 425 int target_read_buffer(struct target *target,
 426                 uint32_t address, uint32_t size, uint8_t *buffer);
 427 int target_checksum_memory(struct target *target,
 428                 uint32_t address, uint32_t size, uint32_t* crc);
 429 int target_blank_check_memory(struct target *target,
 430                 uint32_t address, uint32_t size, uint32_t* blank);
 431 int target_wait_state(struct target *target, enum target_state state, int ms);
 432
 433 /** Return the *name* of this targets current state */
 434 const char *target_state_name( struct target *target );
 435
 436 /* DANGER!!!!!
 437  *
 438  * if "area" passed in to target_alloc_working_area() points to a memory
 439  * location that goes out of scope (e.g. a pointer on the stack), then
 440  * the caller of target_alloc_working_area() is responsible for invoking
 441  * target_free_working_area() before "area" goes out of scope.
 442  *
 443  * target_free_all_working_areas() will NULL out the "area" pointer
 444  * upon resuming or resetting the CPU.
 445  *
 446  */
 447 int target_alloc_working_area(struct target *target,
 448                 uint32_t size, struct working_area **area);
 449 int target_free_working_area(struct target *target, struct working_area *area);
 450 int target_free_working_area_restore(struct target *target,
 451                 struct working_area *area, int restore);
 452 void target_free_all_working_areas(struct target *target);
 453 void target_free_all_working_areas_restore(struct target *target, int restore);
 454
 455 extern struct target *all_targets;
 456
 457 extern struct target_event_callback *target_event_callbacks;
 458 extern struct target_timer_callback *target_timer_callbacks;
 459
 460 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
 461 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
 462 uint8_t  target_buffer_get_u8 (struct target *target, const uint8_t *buffer);
 463 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
 464 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
 465 void target_buffer_set_u8 (struct target *target, uint8_t *buffer, uint8_t  value);
 466
 467 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
 468 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
 469 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
 470 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
 471 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
 472 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
 473
 474 /* Issues USER() statements with target state information */
 475 int target_arch_state(struct target *target);
 476
 477 void target_handle_event(struct target *t, enum target_event e);
 478 void target_all_handle_event(enum target_event e);
 479
 480 #define ERROR_TARGET_INVALID    (-300)
 481 #define ERROR_TARGET_INIT_FAILED (-301)
 482 #define ERROR_TARGET_TIMEOUT    (-302)
 483 #define ERROR_TARGET_NOT_HALTED (-304)
 484 #define ERROR_TARGET_FAILURE    (-305)
 485 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 486 #define ERROR_TARGET_DATA_ABORT (-307)
 487 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 488 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 489 #define ERROR_TARGET_NOT_RUNNING (-310)
 490 #define ERROR_TARGET_NOT_EXAMINED (-311)
 491
 492 extern const Jim_Nvp nvp_error_target[];
 493
 494 const char *target_strerror_safe(int err);
 495
 496 #endif /* TARGET_H */