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         bool smp_halt_event_postponed;          /* Some SMP implementations (currently Cortex-M) stores
 197                                                                                  * 'halted' events and emits them after all targets of
 198                                                                                  * the SMP group has been polled */
 199
 200         /* the gdb service is there in case of smp, we have only one gdb server
 201          * for all smp target
 202          * the target attached to the gdb is changing dynamically by changing
 203          * gdb_service->target pointer */
 204         struct gdb_service *gdb_service;
 205
 206         /* file-I/O information for host to do syscall */
 207         struct gdb_fileio_info *fileio_info;
 208
 209         char *gdb_port_override;                        /* target-specific override for gdb_port */
 210
 211         int gdb_max_connections;                        /* max number of simultaneous gdb connections */
 212
 213         /* The semihosting information, extracted from the target. */
 214         struct semihosting *semihosting;
 215 };
 216
 217 struct target_list {
 218         struct list_head lh;
 219         struct target *target;
 220 };
 221
 222 struct gdb_fileio_info {
 223         char *identifier;
 224         uint64_t param_1;
 225         uint64_t param_2;
 226         uint64_t param_3;
 227         uint64_t param_4;
 228 };
 229
 230 /** Returns a description of the endianness for the specified target. */
 231 static inline const char *target_endianness(struct target *target)
 232 {
 233         return (target->endianness == TARGET_ENDIAN_UNKNOWN) ? "unknown" :
 234                         (target->endianness == TARGET_BIG_ENDIAN) ? "big endian" : "little endian";
 235 }
 236
 237 /** Returns the instance-specific name of the specified target. */
 238 static inline const char *target_name(struct target *target)
 239 {
 240         return target->cmd_name;
 241 }
 242
 243 const char *debug_reason_name(struct target *t);
 244
 245 enum target_event {
 246
 247         /* allow GDB to do stuff before others handle the halted event,
 248          * this is in lieu of defining ordering of invocation of events,
 249          * which would be more complicated
 250          *
 251          * Telling GDB to halt does not mean that the target stopped running,
 252          * simply that we're dropping out of GDB's waiting for step or continue.
 253          *
 254          * This can be useful when e.g. detecting power dropout.
 255          */
 256         TARGET_EVENT_GDB_HALT,
 257         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 258         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 259         TARGET_EVENT_RESUME_START,
 260         TARGET_EVENT_RESUME_END,
 261         TARGET_EVENT_STEP_START,
 262         TARGET_EVENT_STEP_END,
 263
 264         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 265         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 266
 267         TARGET_EVENT_RESET_START,
 268         TARGET_EVENT_RESET_ASSERT_PRE,
 269         TARGET_EVENT_RESET_ASSERT,      /* C code uses this instead of SRST */
 270         TARGET_EVENT_RESET_ASSERT_POST,
 271         TARGET_EVENT_RESET_DEASSERT_PRE,
 272         TARGET_EVENT_RESET_DEASSERT_POST,
 273         TARGET_EVENT_RESET_INIT,
 274         TARGET_EVENT_RESET_END,
 275
 276         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 277         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 278
 279         TARGET_EVENT_EXAMINE_START,
 280         TARGET_EVENT_EXAMINE_FAIL,
 281         TARGET_EVENT_EXAMINE_END,
 282
 283         TARGET_EVENT_GDB_ATTACH,
 284         TARGET_EVENT_GDB_DETACH,
 285
 286         TARGET_EVENT_GDB_FLASH_ERASE_START,
 287         TARGET_EVENT_GDB_FLASH_ERASE_END,
 288         TARGET_EVENT_GDB_FLASH_WRITE_START,
 289         TARGET_EVENT_GDB_FLASH_WRITE_END,
 290
 291         TARGET_EVENT_TRACE_CONFIG,
 292
 293         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X100 = 0x100, /* semihosting allows user cmds from 0x100 to 0x1ff */
 294         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X101 = 0x101,
 295         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X102 = 0x102,
 296         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X103 = 0x103,
 297         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X104 = 0x104,
 298         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X105 = 0x105,
 299         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X106 = 0x106,
 300         TARGET_EVENT_SEMIHOSTING_USER_CMD_0X107 = 0x107,
 301 };
 302
 303 struct target_event_action {
 304         enum target_event event;
 305         Jim_Interp *interp;
 306         Jim_Obj *body;
 307         struct target_event_action *next;
 308 };
 309
 310 bool target_has_event_action(struct target *target, enum target_event event);
 311
 312 struct target_event_callback {
 313         int (*callback)(struct target *target, enum target_event event, void *priv);
 314         void *priv;
 315         struct target_event_callback *next;
 316 };
 317
 318 struct target_reset_callback {
 319         struct list_head list;
 320         void *priv;
 321         int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
 322 };
 323
 324 struct target_trace_callback {
 325         struct list_head list;
 326         void *priv;
 327         int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
 328 };
 329
 330 enum target_timer_type {
 331         TARGET_TIMER_TYPE_ONESHOT,
 332         TARGET_TIMER_TYPE_PERIODIC
 333 };
 334
 335 struct target_timer_callback {
 336         int (*callback)(void *priv);
 337         unsigned int time_ms;
 338         enum target_timer_type type;
 339         bool removed;
 340         int64_t when;   /* output of timeval_ms() */
 341         void *priv;
 342         struct target_timer_callback *next;
 343 };
 344
 345 struct target_memory_check_block {
 346         target_addr_t address;
 347         uint32_t size;
 348         uint32_t result;
 349 };
 350
 351 int target_register_commands(struct command_context *cmd_ctx);
 352 int target_examine(void);
 353
 354 int target_register_event_callback(
 355                 int (*callback)(struct target *target,
 356                 enum target_event event, void *priv),
 357                 void *priv);
 358 int target_unregister_event_callback(
 359                 int (*callback)(struct target *target,
 360                 enum target_event event, void *priv),
 361                 void *priv);
 362
 363 int target_register_reset_callback(
 364                 int (*callback)(struct target *target,
 365                 enum target_reset_mode reset_mode, void *priv),
 366                 void *priv);
 367 int target_unregister_reset_callback(
 368                 int (*callback)(struct target *target,
 369                 enum target_reset_mode reset_mode, void *priv),
 370                 void *priv);
 371
 372 int target_register_trace_callback(
 373                 int (*callback)(struct target *target,
 374                 size_t len, uint8_t *data, void *priv),
 375                 void *priv);
 376 int target_unregister_trace_callback(
 377                 int (*callback)(struct target *target,
 378                 size_t len, uint8_t *data, void *priv),
 379                 void *priv);
 380
 381 /* Poll the status of the target, detect any error conditions and report them.
 382  *
 383  * Also note that this fn will clear such error conditions, so a subsequent
 384  * invocation will then succeed.
 385  *
 386  * These error conditions can be "sticky" error conditions. E.g. writing
 387  * to memory could be implemented as an open loop and if memory writes
 388  * fails, then a note is made of it, the error is sticky, but the memory
 389  * write loop still runs to completion. This improves performance in the
 390  * normal case as there is no need to verify that every single write succeed,
 391  * yet it is possible to detect error conditions.
 392  */
 393 int target_poll(struct target *target);
 394 int target_resume(struct target *target, int current, target_addr_t address,
 395                 int handle_breakpoints, int debug_execution);
 396 int target_halt(struct target *target);
 397 int target_call_event_callbacks(struct target *target, enum target_event event);
 398 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
 399 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
 400
 401 /**
 402  * The period is very approximate, the callback can happen much more often
 403  * or much more rarely than specified
 404  */
 405 int target_register_timer_callback(int (*callback)(void *priv),
 406                 unsigned int time_ms, enum target_timer_type type, void *priv);
 407 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 408 int target_call_timer_callbacks(void);
 409 /**
 410  * Invoke this to ensure that e.g. polling timer callbacks happen before
 411  * a synchronous command completes.
 412  */
 413 int target_call_timer_callbacks_now(void);
 414 /**
 415  * Returns when the next registered event will take place. Callers can use this
 416  * to go to sleep until that time occurs.
 417  */
 418 int64_t target_timer_next_event(void);
 419
 420 struct target *get_target_by_num(int num);
 421 struct target *get_current_target(struct command_context *cmd_ctx);
 422 struct target *get_current_target_or_null(struct command_context *cmd_ctx);
 423 struct target *get_target(const char *id);
 424
 425 /**
 426  * Get the target type name.
 427  *
 428  * This routine is a wrapper for the target->type->name field.
 429  * Note that this is not an instance-specific name for his target.
 430  */
 431 const char *target_type_name(struct target *target);
 432
 433 /**
 434  * Examine the specified @a target, letting it perform any
 435  * Initialisation that requires JTAG access.
 436  *
 437  * This routine is a wrapper for target->type->examine.
 438  */
 439 int target_examine_one(struct target *target);
 440
 441 /** @returns @c true if target_set_examined() has been called. */
 442 static inline bool target_was_examined(struct target *target)
 443 {
 444         return target->examined;
 445 }
 446
 447 /** Sets the @c examined flag for the given target. */
 448 /** Use in target->type->examine() after one-time setup is done. */
 449 static inline void target_set_examined(struct target *target)
 450 {
 451         target->examined = true;
 452 }
 453
 454 /**
 455  * Add the @a breakpoint for @a target.
 456  *
 457  * This routine is a wrapper for target->type->add_breakpoint.
 458  */
 459 int target_add_breakpoint(struct target *target,
 460                 struct breakpoint *breakpoint);
 461 /**
 462  * Add the @a ContextID breakpoint  for @a target.
 463  *
 464  * This routine is a wrapper for target->type->add_context_breakpoint.
 465  */
 466 int target_add_context_breakpoint(struct target *target,
 467                 struct breakpoint *breakpoint);
 468 /**
 469  * Add the @a ContextID & IVA breakpoint  for @a target.
 470  *
 471  * This routine is a wrapper for target->type->add_hybrid_breakpoint.
 472  */
 473 int target_add_hybrid_breakpoint(struct target *target,
 474                 struct breakpoint *breakpoint);
 475 /**
 476  * Remove the @a breakpoint for @a target.
 477  *
 478  * This routine is a wrapper for target->type->remove_breakpoint.
 479  */
 480
 481 int target_remove_breakpoint(struct target *target,
 482                 struct breakpoint *breakpoint);
 483 /**
 484  * Add the @a watchpoint for @a target.
 485  *
 486  * This routine is a wrapper for target->type->add_watchpoint.
 487  */
 488 int target_add_watchpoint(struct target *target,
 489                 struct watchpoint *watchpoint);
 490 /**
 491  * Remove the @a watchpoint for @a target.
 492  *
 493  * This routine is a wrapper for target->type->remove_watchpoint.
 494  */
 495 int target_remove_watchpoint(struct target *target,
 496                 struct watchpoint *watchpoint);
 497
 498 /**
 499  * Find out the just hit @a watchpoint for @a target.
 500  *
 501  * This routine is a wrapper for target->type->hit_watchpoint.
 502  */
 503 int target_hit_watchpoint(struct target *target,
 504                 struct watchpoint **watchpoint);
 505
 506 /**
 507  * Obtain the architecture for GDB.
 508  *
 509  * This routine is a wrapper for target->type->get_gdb_arch.
 510  */
 511 const char *target_get_gdb_arch(struct target *target);
 512
 513 /**
 514  * Obtain the registers for GDB.
 515  *
 516  * This routine is a wrapper for target->type->get_gdb_reg_list.
 517  */
 518 int target_get_gdb_reg_list(struct target *target,
 519                 struct reg **reg_list[], int *reg_list_size,
 520                 enum target_register_class reg_class);
 521
 522 /**
 523  * Obtain the registers for GDB, but don't read register values from the
 524  * target.
 525  *
 526  * This routine is a wrapper for target->type->get_gdb_reg_list_noread.
 527  */
 528 int target_get_gdb_reg_list_noread(struct target *target,
 529                 struct reg **reg_list[], int *reg_list_size,
 530                 enum target_register_class reg_class);
 531
 532 /**
 533  * Check if @a target allows GDB connections.
 534  *
 535  * Some target do not implement the necessary code required by GDB.
 536  */
 537 bool target_supports_gdb_connection(struct target *target);
 538
 539 /**
 540  * Step the target.
 541  *
 542  * This routine is a wrapper for target->type->step.
 543  */
 544 int target_step(struct target *target,
 545                 int current, target_addr_t address, int handle_breakpoints);
 546 /**
 547  * Run an algorithm on the @a target given.
 548  *
 549  * This routine is a wrapper for target->type->run_algorithm.
 550  */
 551 int target_run_algorithm(struct target *target,
 552                 int num_mem_params, struct mem_param *mem_params,
 553                 int num_reg_params, struct reg_param *reg_param,
 554                 target_addr_t entry_point, target_addr_t exit_point,
 555                 int timeout_ms, void *arch_info);
 556
 557 /**
 558  * Starts an algorithm in the background on the @a target given.
 559  *
 560  * This routine is a wrapper for target->type->start_algorithm.
 561  */
 562 int target_start_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                 target_addr_t entry_point, target_addr_t exit_point,
 566                 void *arch_info);
 567
 568 /**
 569  * Wait for an algorithm on the @a target given.
 570  *
 571  * This routine is a wrapper for target->type->wait_algorithm.
 572  */
 573 int target_wait_algorithm(struct target *target,
 574                 int num_mem_params, struct mem_param *mem_params,
 575                 int num_reg_params, struct reg_param *reg_params,
 576                 target_addr_t exit_point, int timeout_ms,
 577                 void *arch_info);
 578
 579 /**
 580  * This routine is a wrapper for asynchronous algorithms.
 581  *
 582  */
 583 int target_run_flash_async_algorithm(struct target *target,
 584                 const uint8_t *buffer, uint32_t count, int block_size,
 585                 int num_mem_params, struct mem_param *mem_params,
 586                 int num_reg_params, struct reg_param *reg_params,
 587                 uint32_t buffer_start, uint32_t buffer_size,
 588                 uint32_t entry_point, uint32_t exit_point,
 589                 void *arch_info);
 590
 591 /**
 592  * This routine is a wrapper for asynchronous algorithms.
 593  *
 594  */
 595 int target_run_read_async_algorithm(struct target *target,
 596                 uint8_t *buffer, uint32_t count, int block_size,
 597                 int num_mem_params, struct mem_param *mem_params,
 598                 int num_reg_params, struct reg_param *reg_params,
 599                 uint32_t buffer_start, uint32_t buffer_size,
 600                 uint32_t entry_point, uint32_t exit_point,
 601                 void *arch_info);
 602
 603 /**
 604  * Read @a count items of @a size bytes from the memory of @a target at
 605  * the @a address given.
 606  *
 607  * This routine is a wrapper for target->type->read_memory.
 608  */
 609 int target_read_memory(struct target *target,
 610                 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 611 int target_read_phys_memory(struct target *target,
 612                 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 613 /**
 614  * Write @a count items of @a size bytes to the memory of @a target at
 615  * the @a address given. @a address must be aligned to @a size
 616  * in target memory.
 617  *
 618  * The endianness is the same in the host and target memory for this
 619  * function.
 620  *
 621  * \todo TODO:
 622  * Really @a buffer should have been defined as "const void *" and
 623  * @a buffer should have been aligned to @a size in the host memory.
 624  *
 625  * This is not enforced via e.g. assert's today and e.g. the
 626  * target_write_buffer fn breaks this assumption.
 627  *
 628  * This routine is wrapper for target->type->write_memory.
 629  */
 630 int target_write_memory(struct target *target,
 631                 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
 632 int target_write_phys_memory(struct target *target,
 633                 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
 634
 635 /*
 636  * Write to target memory using the virtual address.
 637  *
 638  * Note that this fn is used to implement software breakpoints. Targets
 639  * can implement support for software breakpoints to memory marked as read
 640  * only by making this fn write to ram even if it is read only(MMU or
 641  * MPUs).
 642  *
 643  * It is sufficient to implement for writing a single word(16 or 32 in
 644  * ARM32/16 bit case) to write the breakpoint to ram.
 645  *
 646  * The target should also take care of "other things" to make sure that
 647  * software breakpoints can be written using this function. E.g.
 648  * when there is a separate instruction and data cache, this fn must
 649  * make sure that the instruction cache is synced up to the potential
 650  * code change that can happen as a result of the memory write(typically
 651  * by invalidating the cache).
 652  *
 653  * The high level wrapper fn in target.c will break down this memory write
 654  * request to multiple write requests to the target driver to e.g. guarantee
 655  * that writing 4 bytes to an aligned address happens with a single 32 bit
 656  * write operation, thus making this fn suitable to e.g. write to special
 657  * peripheral registers which do not support byte operations.
 658  */
 659 int target_write_buffer(struct target *target,
 660                 target_addr_t address, uint32_t size, const uint8_t *buffer);
 661 int target_read_buffer(struct target *target,
 662                 target_addr_t address, uint32_t size, uint8_t *buffer);
 663 int target_checksum_memory(struct target *target,
 664                 target_addr_t address, uint32_t size, uint32_t *crc);
 665 int target_blank_check_memory(struct target *target,
 666                 struct target_memory_check_block *blocks, int num_blocks,
 667                 uint8_t erased_value);
 668 int target_wait_state(struct target *target, enum target_state state, int ms);
 669
 670 /**
 671  * Obtain file-I/O information from target for GDB to do syscall.
 672  *
 673  * This routine is a wrapper for target->type->get_gdb_fileio_info.
 674  */
 675 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
 676
 677 /**
 678  * Pass GDB file-I/O response to target after finishing host syscall.
 679  *
 680  * This routine is a wrapper for target->type->gdb_fileio_end.
 681  */
 682 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
 683
 684 /**
 685  * Return the highest accessible address for this target.
 686  */
 687 target_addr_t target_address_max(struct target *target);
 688
 689 /**
 690  * Return the number of address bits this target supports.
 691  *
 692  * This routine is a wrapper for target->type->address_bits.
 693  */
 694 unsigned target_address_bits(struct target *target);
 695
 696 /**
 697  * Return the number of data bits this target supports.
 698  *
 699  * This routine is a wrapper for target->type->data_bits.
 700  */
 701 unsigned int target_data_bits(struct target *target);
 702
 703 /** Return the *name* of this targets current state */
 704 const char *target_state_name(struct target *target);
 705
 706 /** Return the *name* of a target event enumeration value */
 707 const char *target_event_name(enum target_event event);
 708
 709 /** Return the *name* of a target reset reason enumeration value */
 710 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
 711
 712 /* DANGER!!!!!
 713  *
 714  * if "area" passed in to target_alloc_working_area() points to a memory
 715  * location that goes out of scope (e.g. a pointer on the stack), then
 716  * the caller of target_alloc_working_area() is responsible for invoking
 717  * target_free_working_area() before "area" goes out of scope.
 718  *
 719  * target_free_all_working_areas() will NULL out the "area" pointer
 720  * upon resuming or resetting the CPU.
 721  *
 722  */
 723 int target_alloc_working_area(struct target *target,
 724                 uint32_t size, struct working_area **area);
 725 /* Same as target_alloc_working_area, except that no error is logged
 726  * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
 727  *
 728  * This allows the calling code to *try* to allocate target memory
 729  * and have a fallback to another behaviour(slower?).
 730  */
 731 int target_alloc_working_area_try(struct target *target,
 732                 uint32_t size, struct working_area **area);
 733 /**
 734  * Free a working area.
 735  * Restore target data if area backup is configured.
 736  * @param target
 737  * @param area Pointer to the area to be freed or NULL
 738  * @returns ERROR_OK if successful; error code if restore failed
 739  */
 740 int target_free_working_area(struct target *target, struct working_area *area);
 741 void target_free_all_working_areas(struct target *target);
 742 uint32_t target_get_working_area_avail(struct target *target);
 743
 744 /**
 745  * Free all the resources allocated by targets and the target layer
 746  */
 747 void target_quit(void);
 748
 749 extern struct target *all_targets;
 750
 751 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
 752 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
 753 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
 754 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
 755 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
 756 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
 757 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
 758 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
 759
 760 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
 761 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
 762 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
 763 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
 764 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
 765 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
 766
 767 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
 768 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
 769 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
 770 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
 771 int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
 772 int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
 773 int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
 774 int target_write_u8(struct target *target, target_addr_t address, uint8_t value);
 775
 776 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
 777 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
 778 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
 779 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
 780
 781 /* Issues USER() statements with target state information */
 782 int target_arch_state(struct target *target);
 783
 784 void target_handle_event(struct target *t, enum target_event e);
 785
 786 void target_handle_md_output(struct command_invocation *cmd,
 787         struct target *target, target_addr_t address, unsigned size,
 788         unsigned count, const uint8_t *buffer);
 789
 790 int target_profiling_default(struct target *target, uint32_t *samples, uint32_t
 791                 max_num_samples, uint32_t *num_samples, uint32_t seconds);
 792
 793 #define ERROR_TARGET_INVALID    (-300)
 794 #define ERROR_TARGET_INIT_FAILED (-301)
 795 #define ERROR_TARGET_TIMEOUT    (-302)
 796 #define ERROR_TARGET_NOT_HALTED (-304)
 797 #define ERROR_TARGET_FAILURE    (-305)
 798 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 799 #define ERROR_TARGET_DATA_ABORT (-307)
 800 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 801 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 802 #define ERROR_TARGET_NOT_RUNNING (-310)
 803 #define ERROR_TARGET_NOT_EXAMINED (-311)
 804 #define ERROR_TARGET_DUPLICATE_BREAKPOINT (-312)
 805 #define ERROR_TARGET_ALGO_EXIT  (-313)
 806
 807 extern bool get_target_reset_nag(void);
 808
 809 #define TARGET_DEFAULT_POLLING_INTERVAL         100
 810
 811 #endif /* OPENOCD_TARGET_TARGET_H */