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