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