src/target/target.h

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