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