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