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