src/target/target.h

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