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