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