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  *   Copyright (C) 2011 by Broadcom Corporation                            *
  12  *   Evan Hunter - ehunter@broadcom.com                                    *
  13  *                                                                         *
  14  *   Copyright (C) ST-Ericsson SA 2011                                     *
  15  *   michel.jaouen@stericsson.com : smp minimum support                    *
  16  *                                                                         *
  17  *   This program is free software; you can redistribute it and/or modify  *
  18  *   it under the terms of the GNU General Public License as published by  *
  19  *   the Free Software Foundation; either version 2 of the License, or     *
  20  *   (at your option) any later version.                                   *
  21  *                                                                         *
  22  *   This program is distributed in the hope that it will be useful,       *
  23  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  24  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  25  *   GNU General Public License for more details.                          *
  26  *                                                                         *
  27  *   You should have received a copy of the GNU General Public License     *
  28  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  29  ***************************************************************************/
  30
  31 #ifndef OPENOCD_TARGET_TARGET_H
  32 #define OPENOCD_TARGET_TARGET_H
  33
  34 #include <helper/list.h>
  35
  36 struct reg;
  37 struct trace;
  38 struct command_context;
  39 struct breakpoint;
  40 struct watchpoint;
  41 struct mem_param;
  42 struct reg_param;
  43 struct target_list;
  44 struct gdb_fileio_info;
  45
  46 /*
  47  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
  48  * TARGET_RUNNING = 1: the target is executing user code
  49  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  50  * debugger. on an xscale it means that the debug handler is executing
  51  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  52  * not sure how this is used with all the recent changes)
  53  * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  54  * behalf of the debugger (e.g. algorithm for flashing)
  55  *
  56  * also see: target_state_name();
  57  */
  58
  59 enum target_state {
  60         TARGET_UNKNOWN = 0,
  61         TARGET_RUNNING = 1,
  62         TARGET_HALTED = 2,
  63         TARGET_RESET = 3,
  64         TARGET_DEBUG_RUNNING = 4,
  65 };
  66
  67 enum nvp_assert {
  68         NVP_DEASSERT,
  69         NVP_ASSERT,
  70 };
  71
  72 enum target_reset_mode {
  73         RESET_UNKNOWN = 0,
  74         RESET_RUN = 1,          /* reset and let target run */
  75         RESET_HALT = 2,         /* reset and halt target out of reset */
  76         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
  77 };
  78
  79 enum target_debug_reason {
  80         DBG_REASON_DBGRQ = 0,
  81         DBG_REASON_BREAKPOINT = 1,
  82         DBG_REASON_WATCHPOINT = 2,
  83         DBG_REASON_WPTANDBKPT = 3,
  84         DBG_REASON_SINGLESTEP = 4,
  85         DBG_REASON_NOTHALTED = 5,
  86         DBG_REASON_EXIT = 6,
  87         DBG_REASON_EXC_CATCH = 7,
  88         DBG_REASON_UNDEFINED = 8,
  89 };
  90
  91 enum target_endianness {
  92         TARGET_ENDIAN_UNKNOWN = 0,
  93         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
  94 };
  95
  96 struct working_area {
  97         target_addr_t address;
  98         uint32_t size;
  99         bool free;
 100         uint8_t *backup;
 101         struct working_area **user;
 102         struct working_area *next;
 103 };
 104
 105 struct gdb_service {
 106         struct target *target;
 107         /*  field for smp display  */
 108         /*  element 0 coreid currently displayed ( 1 till n) */
 109         /*  element 1 coreid to be displayed at next resume 1 till n 0 means resume
 110          *  all cores core displayed  */
 111         int32_t core[2];
 112 };
 113
 114 /* target back off timer */
 115 struct backoff_timer {
 116         int times;
 117         int count;
 118 };
 119
 120 /* split target registers into multiple class */
 121 enum target_register_class {
 122         REG_CLASS_ALL,
 123         REG_CLASS_GENERAL,
 124 };
 125
 126 /* target_type.h contains the full definition of struct target_type */
 127 struct target {
 128         struct target_type *type;                       /* target type definition (name, access functions) */
 129         char *cmd_name;                         /* tcl Name of target */
 130         int target_number;                                      /* DO NOT USE!  field to be removed in 2010 */
 131         struct jtag_tap *tap;                           /* where on the jtag chain is this */
 132         int32_t coreid;                                         /* which device on the TAP? */
 133
 134         /** Should we defer examine to later */
 135         bool defer_examine;
 136
 137         /**
 138          * Indicates whether this target has been examined.
 139          *
 140          * Do @b not access this field directly, use target_was_examined()
 141          * or target_set_examined().
 142          */
 143         bool examined;
 144
 145         /**
 146          * true if the  target is currently running a downloaded
 147          * "algorithm" instead of arbitrary user code. OpenOCD code
 148          * invoking algorithms is trusted to maintain correctness of
 149          * any cached state (e.g. for flash status), which arbitrary
 150          * code will have no reason to know about.
 151          */
 152         bool running_alg;
 153
 154         struct target_event_action *event_action;
 155
 156         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
 157         target_addr_t working_area;                             /* working area (initialised RAM). Evaluated
 158                                                                                  * upon first allocation from virtual/physical address. */
 159         bool working_area_virt_spec;            /* virtual address specified? */
 160         target_addr_t working_area_virt;                        /* virtual address */
 161         bool working_area_phys_spec;            /* physical address specified? */
 162         target_addr_t working_area_phys;                        /* physical address */
 163         uint32_t working_area_size;                     /* size in bytes */
 164         uint32_t backup_working_area;           /* whether the content of the working area has to be preserved */
 165         struct working_area *working_areas;/* list of allocated working areas */
 166         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 167         enum target_endianness endianness;      /* target endianness */
 168         /* also see: target_state_name() */
 169         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 170         struct reg_cache *reg_cache;            /* the first register cache of the target (core regs) */
 171         struct breakpoint *breakpoints;         /* list of breakpoints */
 172         struct watchpoint *watchpoints;         /* list of watchpoints */
 173         struct trace *trace_info;                       /* generic trace information */
 174         struct debug_msg_receiver *dbgmsg;      /* list of debug message receivers */
 175         uint32_t dbg_msg_enabled;                       /* debug message status */
 176         void *arch_info;                                        /* architecture specific information */
 177         void *private_config;                           /* pointer to target specific config data (for jim_configure hook) */
 178         struct target *next;                            /* next target in list */
 179
 180         bool verbose_halt_msg;                          /* display async info in telnet session. Do not display
 181                                                                                  * lots of halted/resumed info when stepping in debugger. */
 182         bool halt_issued;                                       /* did we transition to halted state? */
 183         int64_t halt_issued_time;                       /* Note time when halt was issued */
 184
 185                                                                                 /* ARM v7/v8 targets with ADIv5 interface */
 186         bool dbgbase_set;                                       /* By default the debug base is not set */
 187         uint32_t dbgbase;                                       /* Really a Cortex-A specific option, but there is no
 188                                                                                  * system in place to support target specific options
 189                                                                                  * currently. */
 190         bool has_dap;                                           /* set to true if target has ADIv5 support */
 191         bool dap_configured;                            /* set to true if ADIv5 DAP is configured */
 192         bool tap_configured;                            /* set to true if JTAG tap has been configured
 193                                                                                  * through -chain-position */
 194
 195         struct rtos *rtos;                                      /* Instance of Real Time Operating System support */
 196         bool rtos_auto_detect;                          /* A flag that indicates that the RTOS has been specified as "auto"
 197                                                                                  * and must be detected when symbols are offered */
 198         struct backoff_timer backoff;
 199         int smp;                                                        /* add some target attributes for smp support */
 200         struct target_list *head;
 201         /* the gdb service is there in case of smp, we have only one gdb server
 202          * for all smp target
 203          * the target attached to the gdb is changing dynamically by changing
 204          * gdb_service->target pointer */
 205         struct gdb_service *gdb_service;
 206
 207         /* file-I/O information for host to do syscall */
 208         struct gdb_fileio_info *fileio_info;
 209
 210         char *gdb_port_override;                        /* target-specific override for gdb_port */
 211
 212         /* The semihosting information, extracted from the target. */
 213         struct semihosting *semihosting;
 214 };
 215
 216 struct target_list {
 217         struct target *target;
 218         struct target_list *next;
 219 };
 220
 221 struct gdb_fileio_info {
 222         char *identifier;
 223         uint64_t param_1;
 224         uint64_t param_2;
 225         uint64_t param_3;
 226         uint64_t param_4;
 227 };
 228
 229 /** Returns a description of the endianness for the specified target. */
 230 static inline const char *target_endianness(struct target *target)
 231 {
 232         return (target->endianness == TARGET_ENDIAN_UNKNOWN) ? "unknown" :
 233                         (target->endianness == TARGET_BIG_ENDIAN) ? "big endian" : "little endian";
 234 }
 235
 236 /** Returns the instance-specific name of the specified target. */
 237 static inline const char *target_name(struct target *target)
 238 {
 239         return target->cmd_name;
 240 }
 241
 242 const char *debug_reason_name(struct target *t);
 243
 244 enum target_event {
 245
 246         /* allow GDB to do stuff before others handle the halted event,
 247          * this is in lieu of defining ordering of invocation of events,
 248          * which would be more complicated
 249          *
 250          * Telling GDB to halt does not mean that the target stopped running,
 251          * simply that we're dropping out of GDB's waiting for step or continue.
 252          *
 253          * This can be useful when e.g. detecting power dropout.
 254          */
 255         TARGET_EVENT_GDB_HALT,
 256         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 257         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 258         TARGET_EVENT_RESUME_START,
 259         TARGET_EVENT_RESUME_END,
 260
 261         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 262         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 263
 264         TARGET_EVENT_RESET_START,
 265         TARGET_EVENT_RESET_ASSERT_PRE,
 266         TARGET_EVENT_RESET_ASSERT,      /* C code uses this instead of SRST */
 267         TARGET_EVENT_RESET_ASSERT_POST,
 268         TARGET_EVENT_RESET_DEASSERT_PRE,
 269         TARGET_EVENT_RESET_DEASSERT_POST,
 270         TARGET_EVENT_RESET_INIT,
 271         TARGET_EVENT_RESET_END,
 272
 273         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 274         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 275
 276         TARGET_EVENT_EXAMINE_START,
 277         TARGET_EVENT_EXAMINE_END,
 278
 279         TARGET_EVENT_GDB_ATTACH,
 280         TARGET_EVENT_GDB_DETACH,
 281
 282         TARGET_EVENT_GDB_FLASH_ERASE_START,
 283         TARGET_EVENT_GDB_FLASH_ERASE_END,
 284         TARGET_EVENT_GDB_FLASH_WRITE_START,
 285         TARGET_EVENT_GDB_FLASH_WRITE_END,
 286
 287         TARGET_EVENT_TRACE_CONFIG,
 288 };
 289
 290 struct target_event_action {
 291         enum target_event event;
 292         struct Jim_Interp *interp;
 293         struct Jim_Obj *body;
 294         int has_percent;
 295         struct target_event_action *next;
 296 };
 297
 298 bool target_has_event_action(struct target *target, enum target_event event);
 299
 300 struct target_event_callback {
 301         int (*callback)(struct target *target, enum target_event event, void *priv);
 302         void *priv;
 303         struct target_event_callback *next;
 304 };
 305
 306 struct target_reset_callback {
 307         struct list_head list;
 308         void *priv;
 309         int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
 310 };
 311
 312 struct target_trace_callback {
 313         struct list_head list;
 314         void *priv;
 315         int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
 316 };
 317
 318 enum target_timer_type {
 319         TARGET_TIMER_TYPE_ONESHOT,
 320         TARGET_TIMER_TYPE_PERIODIC
 321 };
 322
 323 struct target_timer_callback {
 324         int (*callback)(void *priv);
 325         unsigned int time_ms;
 326         enum target_timer_type type;
 327         bool removed;
 328         struct timeval when;
 329         void *priv;
 330         struct target_timer_callback *next;
 331 };
 332
 333 struct target_memory_check_block {
 334         target_addr_t address;
 335         uint32_t size;
 336         uint32_t result;
 337 };
 338
 339 int target_register_commands(struct command_context *cmd_ctx);
 340 int target_examine(void);
 341
 342 int target_register_event_callback(
 343                 int (*callback)(struct target *target,
 344                 enum target_event event, void *priv),
 345                 void *priv);
 346 int target_unregister_event_callback(
 347                 int (*callback)(struct target *target,
 348                 enum target_event event, void *priv),
 349                 void *priv);
 350
 351 int target_register_reset_callback(
 352                 int (*callback)(struct target *target,
 353                 enum target_reset_mode reset_mode, void *priv),
 354                 void *priv);
 355 int target_unregister_reset_callback(
 356                 int (*callback)(struct target *target,
 357                 enum target_reset_mode reset_mode, void *priv),
 358                 void *priv);
 359
 360 int target_register_trace_callback(
 361                 int (*callback)(struct target *target,
 362                 size_t len, uint8_t *data, void *priv),
 363                 void *priv);
 364 int target_unregister_trace_callback(
 365                 int (*callback)(struct target *target,
 366                 size_t len, uint8_t *data, void *priv),
 367                 void *priv);
 368
 369 /* Poll the status of the target, detect any error conditions and report them.
 370  *
 371  * Also note that this fn will clear such error conditions, so a subsequent
 372  * invocation will then succeed.
 373  *
 374  * These error conditions can be "sticky" error conditions. E.g. writing
 375  * to memory could be implemented as an open loop and if memory writes
 376  * fails, then a note is made of it, the error is sticky, but the memory
 377  * write loop still runs to completion. This improves performance in the
 378  * normal case as there is no need to verify that every single write succeed,
 379  * yet it is possible to detect error conditions.
 380  */
 381 int target_poll(struct target *target);
 382 int target_resume(struct target *target, int current, target_addr_t address,
 383                 int handle_breakpoints, int debug_execution);
 384 int target_halt(struct target *target);
 385 int target_call_event_callbacks(struct target *target, enum target_event event);
 386 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
 387 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
 388
 389 /**
 390  * The period is very approximate, the callback can happen much more often
 391  * or much more rarely than specified
 392  */
 393 int target_register_timer_callback(int (*callback)(void *priv),
 394                 unsigned int time_ms, enum target_timer_type type, void *priv);
 395 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 396 int target_call_timer_callbacks(void);
 397 /**
 398  * Invoke this to ensure that e.g. polling timer callbacks happen before
 399  * a synchronous command completes.
 400  */
 401 int target_call_timer_callbacks_now(void);
 402
 403 struct target *get_target_by_num(int num);
 404 struct target *get_current_target(struct command_context *cmd_ctx);
 405 struct target *get_current_target_or_null(struct command_context *cmd_ctx);
 406 struct target *get_target(const char *id);
 407
 408 /**
 409  * Get the target type name.
 410  *
 411  * This routine is a wrapper for the target->type->name field.
 412  * Note that this is not an instance-specific name for his target.
 413  */
 414 const char *target_type_name(struct target *target);
 415
 416 /**
 417  * Examine the specified @a target, letting it perform any
 418  * Initialisation that requires JTAG access.
 419  *
 420  * This routine is a wrapper for target->type->examine.
 421  */
 422 int target_examine_one(struct target *target);
 423
 424 /** @returns @c true if target_set_examined() has been called. */
 425 static inline bool target_was_examined(struct target *target)
 426 {
 427         return target->examined;
 428 }
 429
 430 /** Sets the @c examined flag for the given target. */
 431 /** Use in target->type->examine() after one-time setup is done. */
 432 static inline void target_set_examined(struct target *target)
 433 {
 434         target->examined = true;
 435 }
 436
 437 /**
 438  * Add the @a breakpoint for @a target.
 439  *
 440  * This routine is a wrapper for target->type->add_breakpoint.
 441  */
 442 int target_add_breakpoint(struct target *target,
 443                 struct breakpoint *breakpoint);
 444 /**
 445  * Add the @a ContextID breakpoint  for @a target.
 446  *
 447  * This routine is a wrapper for target->type->add_context_breakpoint.
 448  */
 449 int target_add_context_breakpoint(struct target *target,
 450                 struct breakpoint *breakpoint);
 451 /**
 452  * Add the @a ContextID & IVA breakpoint  for @a target.
 453  *
 454  * This routine is a wrapper for target->type->add_hybrid_breakpoint.
 455  */
 456 int target_add_hybrid_breakpoint(struct target *target,
 457                 struct breakpoint *breakpoint);
 458 /**
 459  * Remove the @a breakpoint for @a target.
 460  *
 461  * This routine is a wrapper for target->type->remove_breakpoint.
 462  */
 463
 464 int target_remove_breakpoint(struct target *target,
 465                 struct breakpoint *breakpoint);
 466 /**
 467  * Add the @a watchpoint for @a target.
 468  *
 469  * This routine is a wrapper for target->type->add_watchpoint.
 470  */
 471 int target_add_watchpoint(struct target *target,
 472                 struct watchpoint *watchpoint);
 473 /**
 474  * Remove the @a watchpoint for @a target.
 475  *
 476  * This routine is a wrapper for target->type->remove_watchpoint.
 477  */
 478 int target_remove_watchpoint(struct target *target,
 479                 struct watchpoint *watchpoint);
 480
 481 /**
 482  * Find out the just hit @a watchpoint for @a target.
 483  *
 484  * This routine is a wrapper for target->type->hit_watchpoint.
 485  */
 486 int target_hit_watchpoint(struct target *target,
 487                 struct watchpoint **watchpoint);
 488
 489 /**
 490  * Obtain the architecture for GDB.
 491  *
 492  * This routine is a wrapper for target->type->get_gdb_arch.
 493  */
 494 const char *target_get_gdb_arch(struct target *target);
 495
 496 /**
 497  * Obtain the registers for GDB.
 498  *
 499  * This routine is a wrapper for target->type->get_gdb_reg_list.
 500  */
 501 int target_get_gdb_reg_list(struct target *target,
 502                 struct reg **reg_list[], int *reg_list_size,
 503                 enum target_register_class reg_class);
 504
 505 /**
 506  * Check if @a target allows GDB connections.
 507  *
 508  * Some target do not implement the necessary code required by GDB.
 509  */
 510 bool target_supports_gdb_connection(struct target *target);
 511
 512 /**
 513  * Step the target.
 514  *
 515  * This routine is a wrapper for target->type->step.
 516  */
 517 int target_step(struct target *target,
 518                 int current, target_addr_t address, int handle_breakpoints);
 519 /**
 520  * Run an algorithm on the @a target given.
 521  *
 522  * This routine is a wrapper for target->type->run_algorithm.
 523  */
 524 int target_run_algorithm(struct target *target,
 525                 int num_mem_params, struct mem_param *mem_params,
 526                 int num_reg_params, struct reg_param *reg_param,
 527                 uint32_t entry_point, uint32_t exit_point,
 528                 int timeout_ms, void *arch_info);
 529
 530 /**
 531  * Starts an algorithm in the background on the @a target given.
 532  *
 533  * This routine is a wrapper for target->type->start_algorithm.
 534  */
 535 int target_start_algorithm(struct target *target,
 536                 int num_mem_params, struct mem_param *mem_params,
 537                 int num_reg_params, struct reg_param *reg_params,
 538                 uint32_t entry_point, uint32_t exit_point,
 539                 void *arch_info);
 540
 541 /**
 542  * Wait for an algorithm on the @a target given.
 543  *
 544  * This routine is a wrapper for target->type->wait_algorithm.
 545  */
 546 int target_wait_algorithm(struct target *target,
 547                 int num_mem_params, struct mem_param *mem_params,
 548                 int num_reg_params, struct reg_param *reg_params,
 549                 uint32_t exit_point, int timeout_ms,
 550                 void *arch_info);
 551
 552 /**
 553  * This routine is a wrapper for asynchronous algorithms.
 554  *
 555  */
 556 int target_run_flash_async_algorithm(struct target *target,
 557                 const uint8_t *buffer, uint32_t count, int block_size,
 558                 int num_mem_params, struct mem_param *mem_params,
 559                 int num_reg_params, struct reg_param *reg_params,
 560                 uint32_t buffer_start, uint32_t buffer_size,
 561                 uint32_t entry_point, uint32_t exit_point,
 562                 void *arch_info);
 563
 564 /**
 565  * Read @a count items of @a size bytes from the memory of @a target at
 566  * the @a address given.
 567  *
 568  * This routine is a wrapper for target->type->read_memory.
 569  */
 570 int target_read_memory(struct target *target,
 571                 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 572 int target_read_phys_memory(struct target *target,
 573                 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 574 /**
 575  * Write @a count items of @a size bytes to the memory of @a target at
 576  * the @a address given. @a address must be aligned to @a size
 577  * in target memory.
 578  *
 579  * The endianness is the same in the host and target memory for this
 580  * function.
 581  *
 582  * \todo TODO:
 583  * Really @a buffer should have been defined as "const void *" and
 584  * @a buffer should have been aligned to @a size in the host memory.
 585  *
 586  * This is not enforced via e.g. assert's today and e.g. the
 587  * target_write_buffer fn breaks this assumption.
 588  *
 589  * This routine is wrapper for target->type->write_memory.
 590  */
 591 int target_write_memory(struct target *target,
 592                 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
 593 int target_write_phys_memory(struct target *target,
 594                 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
 595
 596 /*
 597  * Write to target memory using the virtual address.
 598  *
 599  * Note that this fn is used to implement software breakpoints. Targets
 600  * can implement support for software breakpoints to memory marked as read
 601  * only by making this fn write to ram even if it is read only(MMU or
 602  * MPUs).
 603  *
 604  * It is sufficient to implement for writing a single word(16 or 32 in
 605  * ARM32/16 bit case) to write the breakpoint to ram.
 606  *
 607  * The target should also take care of "other things" to make sure that
 608  * software breakpoints can be written using this function. E.g.
 609  * when there is a separate instruction and data cache, this fn must
 610  * make sure that the instruction cache is synced up to the potential
 611  * code change that can happen as a result of the memory write(typically
 612  * by invalidating the cache).
 613  *
 614  * The high level wrapper fn in target.c will break down this memory write
 615  * request to multiple write requests to the target driver to e.g. guarantee
 616  * that writing 4 bytes to an aligned address happens with a single 32 bit
 617  * write operation, thus making this fn suitable to e.g. write to special
 618  * peripheral registers which do not support byte operations.
 619  */
 620 int target_write_buffer(struct target *target,
 621                 target_addr_t address, uint32_t size, const uint8_t *buffer);
 622 int target_read_buffer(struct target *target,
 623                 target_addr_t address, uint32_t size, uint8_t *buffer);
 624 int target_checksum_memory(struct target *target,
 625                 target_addr_t address, uint32_t size, uint32_t *crc);
 626 int target_blank_check_memory(struct target *target,
 627                 struct target_memory_check_block *blocks, int num_blocks,
 628                 uint8_t erased_value);
 629 int target_wait_state(struct target *target, enum target_state state, int ms);
 630
 631 /**
 632  * Obtain file-I/O information from target for GDB to do syscall.
 633  *
 634  * This routine is a wrapper for target->type->get_gdb_fileio_info.
 635  */
 636 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
 637
 638 /**
 639  * Pass GDB file-I/O response to target after finishing host syscall.
 640  *
 641  * This routine is a wrapper for target->type->gdb_fileio_end.
 642  */
 643 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
 644
 645
 646
 647 /** Return the *name* of this targets current state */
 648 const char *target_state_name(struct target *target);
 649
 650 /** Return the *name* of a target event enumeration value */
 651 const char *target_event_name(enum target_event event);
 652
 653 /** Return the *name* of a target reset reason enumeration value */
 654 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
 655
 656 /* DANGER!!!!!
 657  *
 658  * if "area" passed in to target_alloc_working_area() points to a memory
 659  * location that goes out of scope (e.g. a pointer on the stack), then
 660  * the caller of target_alloc_working_area() is responsible for invoking
 661  * target_free_working_area() before "area" goes out of scope.
 662  *
 663  * target_free_all_working_areas() will NULL out the "area" pointer
 664  * upon resuming or resetting the CPU.
 665  *
 666  */
 667 int target_alloc_working_area(struct target *target,
 668                 uint32_t size, struct working_area **area);
 669 /* Same as target_alloc_working_area, except that no error is logged
 670  * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
 671  *
 672  * This allows the calling code to *try* to allocate target memory
 673  * and have a fallback to another behaviour(slower?).
 674  */
 675 int target_alloc_working_area_try(struct target *target,
 676                 uint32_t size, struct working_area **area);
 677 int target_free_working_area(struct target *target, struct working_area *area);
 678 void target_free_all_working_areas(struct target *target);
 679 uint32_t target_get_working_area_avail(struct target *target);
 680
 681 /**
 682  * Free all the resources allocated by targets and the target layer
 683  */
 684 void target_quit(void);
 685
 686 extern struct target *all_targets;
 687
 688 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
 689 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
 690 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
 691 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
 692 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
 693 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
 694 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
 695 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
 696
 697 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
 698 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
 699 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
 700 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
 701 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
 702 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
 703
 704 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
 705 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
 706 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
 707 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
 708 int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
 709 int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
 710 int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
 711 int target_write_u8(struct target *target, target_addr_t address, uint8_t value);
 712
 713 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
 714 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
 715 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
 716 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
 717
 718 /* Issues USER() statements with target state information */
 719 int target_arch_state(struct target *target);
 720
 721 void target_handle_event(struct target *t, enum target_event e);
 722
 723 #define ERROR_TARGET_INVALID    (-300)
 724 #define ERROR_TARGET_INIT_FAILED (-301)
 725 #define ERROR_TARGET_TIMEOUT    (-302)
 726 #define ERROR_TARGET_NOT_HALTED (-304)
 727 #define ERROR_TARGET_FAILURE    (-305)
 728 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 729 #define ERROR_TARGET_DATA_ABORT (-307)
 730 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 731 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 732 #define ERROR_TARGET_NOT_RUNNING (-310)
 733 #define ERROR_TARGET_NOT_EXAMINED (-311)
 734 #define ERROR_TARGET_DUPLICATE_BREAKPOINT (-312)
 735
 736 extern bool get_target_reset_nag(void);
 737
 738 #endif /* OPENOCD_TARGET_TARGET_H */