src/target/target.h

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