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