src/target/target.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008,2009 Øyvind Harboe                            *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef TARGET_H
  27 #define TARGET_H
  28
  29 #include <stddef.h>
  30
  31 #include "breakpoints.h"
  32 #include "algorithm.h"
  33 #include "command.h"
  34
  35 struct reg_s;
  36 struct trace_s;
  37 struct command_context_s;
  38
  39
  40 /**
  41  * Cast a member of a structure out to the containing structure.
  42  * @param ptr The pointer to the member.
  43  * @param type The type of the container struct this is embedded in.
  44  * @param member The name of the member within the struct.
  45  *
  46  * This is a mechanism which is used throughout the Linux kernel.
  47  */
  48 #define container_of(ptr, type, member) ({                      \
  49         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
  50         (type *)( (char *)__mptr - offsetof(type,member) );})
  51
  52 /*
  53  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
  54  * TARGET_RUNNING = 1: the target is executing user code
  55  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  56  * debugger. on an xscale it means that the debug handler is executing
  57  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  58  * not sure how this is used with all the recent changes)
  59  * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  60  * behalf of the debugger (e.g. algorithm for flashing)
  61  *
  62  * also see: target_state_name();
  63  */
  64
  65
  66 enum target_state
  67 {
  68         TARGET_UNKNOWN = 0,
  69         TARGET_RUNNING = 1,
  70         TARGET_HALTED = 2,
  71         TARGET_RESET = 3,
  72         TARGET_DEBUG_RUNNING = 4,
  73 };
  74
  75 extern const Jim_Nvp nvp_target_state[];
  76
  77 enum nvp_assert {
  78         NVP_DEASSERT,
  79         NVP_ASSERT,
  80 };
  81
  82 extern const Jim_Nvp nvp_assert[];
  83
  84 enum target_reset_mode
  85 {
  86         RESET_UNKNOWN = 0,
  87         RESET_RUN = 1,          /* reset and let target run */
  88         RESET_HALT = 2,         /* reset and halt target out of reset */
  89         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
  90 };
  91
  92 extern const Jim_Nvp nvp_reset_mode[];
  93
  94 enum target_debug_reason
  95 {
  96         DBG_REASON_DBGRQ = 0,
  97         DBG_REASON_BREAKPOINT = 1,
  98         DBG_REASON_WATCHPOINT = 2,
  99         DBG_REASON_WPTANDBKPT = 3,
 100         DBG_REASON_SINGLESTEP = 4,
 101         DBG_REASON_NOTHALTED = 5,
 102         DBG_REASON_UNDEFINED = 6
 103 };
 104
 105 extern const Jim_Nvp nvp_target_debug_reason[];
 106
 107 enum target_endianess
 108 {
 109         TARGET_ENDIAN_UNKNOWN = 0,
 110         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
 111 };
 112
 113 extern const Jim_Nvp nvp_target_endian[];
 114
 115 struct target_s;
 116
 117 struct working_area
 118 {
 119         uint32_t address;
 120         uint32_t size;
 121         int free;
 122         uint8_t *backup;
 123         struct working_area **user;
 124         struct working_area *next;
 125 };
 126
 127 // target_type.h contains the full definitionof struct target_type_s
 128 struct target_type_s;
 129 typedef struct target_type_s target_type_t;
 130
 131 typedef struct target_s
 132 {
 133         target_type_t *type;                            /* target type definition (name, access functions) */
 134         const char *cmd_name;                           /* tcl Name of target */
 135         int target_number;                                      /* DO NOT USE!  field to be removed in 2010 */
 136         struct jtag_tap *tap;                                   /* where on the jtag chain is this */
 137         const char *variant;                            /* what varient of this chip is it? */
 138         struct target_event_action *event_action;
 139
 140         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
 141         uint32_t working_area;                                  /* working area (initialized RAM). Evaluated
 142                                                                                  * upon first allocation from virtual/physical address. */
 143         bool working_area_virt_spec;            /* virtual address specified? */
 144         uint32_t working_area_virt;                     /* virtual address */
 145         bool working_area_phys_spec;            /* virtual address specified? */
 146         uint32_t working_area_phys;                     /* physical address */
 147         uint32_t working_area_size;                     /* size in bytes */
 148         uint32_t backup_working_area;                   /* whether the content of the working area has to be preserved */
 149         struct working_area *working_areas;/* list of allocated working areas */
 150         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 151         enum target_endianess endianness;       /* target endianess */
 152         // also see: target_state_name()
 153         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 154         struct reg_cache *reg_cache;            /* the first register cache of the target (core regs) */
 155         struct breakpoint_s *breakpoints;       /* list of breakpoints */
 156         struct watchpoint *watchpoints; /* list of watchpoints */
 157         struct trace_s *trace_info;                     /* generic trace information */
 158         struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
 159         uint32_t dbg_msg_enabled;                               /* debug message status */
 160         void *arch_info;                                        /* architecture specific information */
 161         struct target_s *next;                          /* next target in list */
 162
 163         int display;                                            /* display async info in telnet session. Do not display
 164                                                                                  * lots of halted/resumed info when stepping in debugger. */
 165         bool halt_issued;                                       /* did we transition to halted state? */
 166         long long halt_issued_time;                     /* Note time when halt was issued */
 167 } target_t;
 168
 169 enum target_event
 170 {
 171         /* LD historical names
 172          * - Prior to the great TCL change
 173          * - June/July/Aug 2008
 174          * - Duane Ellis */
 175         TARGET_EVENT_OLD_gdb_program_config,
 176         TARGET_EVENT_OLD_pre_reset,
 177         TARGET_EVENT_OLD_post_reset,
 178         TARGET_EVENT_OLD_pre_resume,
 179
 180         /* allow GDB to do stuff before others handle the halted event,
 181          * this is in lieu of defining ordering of invocation of events,
 182          * which would be more complicated
 183          *
 184          * Telling GDB to halt does not mean that the target stopped running,
 185          * simply that we're dropping out of GDB's waiting for step or continue.
 186          *
 187          * This can be useful when e.g. detecting power dropout.
 188          */
 189         TARGET_EVENT_GDB_HALT,
 190         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 191         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 192         TARGET_EVENT_RESUME_START,
 193         TARGET_EVENT_RESUME_END,
 194
 195         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 196         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 197
 198         TARGET_EVENT_RESET_START,
 199         TARGET_EVENT_RESET_ASSERT_PRE,
 200         TARGET_EVENT_RESET_ASSERT_POST,
 201         TARGET_EVENT_RESET_DEASSERT_PRE,
 202         TARGET_EVENT_RESET_DEASSERT_POST,
 203         TARGET_EVENT_RESET_HALT_PRE,
 204         TARGET_EVENT_RESET_HALT_POST,
 205         TARGET_EVENT_RESET_WAIT_PRE,
 206         TARGET_EVENT_RESET_WAIT_POST,
 207         TARGET_EVENT_RESET_INIT,
 208         TARGET_EVENT_RESET_END,
 209
 210         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 211         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 212
 213         TARGET_EVENT_EXAMINE_START,
 214         TARGET_EVENT_EXAMINE_END,
 215
 216         TARGET_EVENT_GDB_ATTACH,
 217         TARGET_EVENT_GDB_DETACH,
 218
 219         TARGET_EVENT_GDB_FLASH_ERASE_START,
 220         TARGET_EVENT_GDB_FLASH_ERASE_END,
 221         TARGET_EVENT_GDB_FLASH_WRITE_START,
 222         TARGET_EVENT_GDB_FLASH_WRITE_END,
 223 };
 224
 225 struct target_event_action {
 226         enum target_event event;
 227         Jim_Obj *body;
 228         int has_percent;
 229         struct target_event_action *next;
 230  };
 231
 232 struct target_event_callback
 233 {
 234         int (*callback)(struct target_s *target, enum target_event event, void *priv);
 235         void *priv;
 236         struct target_event_callback *next;
 237 };
 238
 239 struct target_timer_callback
 240 {
 241         int (*callback)(void *priv);
 242         int time_ms;
 243         int periodic;
 244         struct timeval when;
 245         void *priv;
 246         struct target_timer_callback *next;
 247 };
 248
 249 int target_register_commands(struct command_context_s *cmd_ctx);
 250 int target_register_user_commands(struct command_context_s *cmd_ctx);
 251 int target_init(struct command_context_s *cmd_ctx);
 252 int target_examine(void);
 253 int handle_target(void *priv);
 254 int target_process_reset(struct command_context_s *cmd_ctx,
 255                 enum target_reset_mode reset_mode);
 256
 257 int target_register_event_callback(
 258                 int (*callback)(struct target_s *target,
 259                                 enum target_event event, void *priv),
 260                 void *priv);
 261 int target_unregister_event_callback(
 262                 int (*callback)(struct target_s *target,
 263                                 enum target_event event, void *priv),
 264                 void *priv);
 265 int target_poll(target_t *target);
 266 int target_resume(target_t *target, int current, uint32_t address,
 267                 int handle_breakpoints, int debug_execution);
 268 int target_halt(target_t *target);
 269 int target_call_event_callbacks(target_t *target, enum target_event event);
 270
 271 /**
 272  * The period is very approximate, the callback can happen much more often
 273  * or much more rarely than specified
 274  */
 275 int target_register_timer_callback(int (*callback)(void *priv),
 276                 int time_ms, int periodic, void *priv);
 277 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 278
 279 int target_call_timer_callbacks(void);
 280 /**
 281  * Invoke this to ensure that e.g. polling timer callbacks happen before
 282  * a syncrhonous command completes.
 283  */
 284 int target_call_timer_callbacks_now(void);
 285
 286 target_t* get_current_target(struct command_context_s *cmd_ctx);
 287 target_t *get_target(const char *id);
 288
 289 /**
 290  * Get the target name.
 291  *
 292  * This routine is a wrapper for the target->type->name field.
 293  */
 294 const char *target_get_name(struct target_s *target);
 295
 296 /**
 297  * Examine the specified @a target.
 298  *
 299  * This routine is a wrapper for target->type->examine.
 300  */
 301 int target_examine_one(struct target_s *target);
 302 /// @returns @c true if the target has been examined.
 303 bool target_was_examined(struct target_s *target);
 304 /// Sets the @c examined flag for the given target.
 305 void target_set_examined(struct target_s *target);
 306 /// Reset the @c examined flag for the given target.
 307 void target_reset_examined(struct target_s *target);
 308
 309
 310 /**
 311  * Add the @a breakpoint for @a target.
 312  *
 313  * This routine is a wrapper for target->type->add_breakpoint.
 314  */
 315 int target_add_breakpoint(struct target_s *target,
 316                 struct breakpoint_s *breakpoint);
 317 /**
 318  * Remove the @a breakpoint for @a target.
 319  *
 320  * This routine is a wrapper for target->type->remove_breakpoint.
 321  */
 322 int target_remove_breakpoint(struct target_s *target,
 323                 struct breakpoint_s *breakpoint);
 324 /**
 325  * Add the @a watchpoint for @a target.
 326  *
 327  * This routine is a wrapper for target->type->add_watchpoint.
 328  */
 329 int target_add_watchpoint(struct target_s *target,
 330                 struct watchpoint *watchpoint);
 331 /**
 332  * Remove the @a watchpoint for @a target.
 333  *
 334  * This routine is a wrapper for target->type->remove_watchpoint.
 335  */
 336 int target_remove_watchpoint(struct target_s *target,
 337                 struct watchpoint *watchpoint);
 338
 339 /**
 340  * Obtain the registers for GDB.
 341  *
 342  * This routine is a wrapper for target->type->get_gdb_reg_list.
 343  */
 344 int target_get_gdb_reg_list(struct target_s *target,
 345                 struct reg_s **reg_list[], int *reg_list_size);
 346
 347 /**
 348  * Step the target.
 349  *
 350  * This routine is a wrapper for target->type->step.
 351  */
 352 int target_step(struct target_s *target,
 353                 int current, uint32_t address, int handle_breakpoints);
 354 /**
 355  * Run an algorithm on the @a target given.
 356  *
 357  * This routine is a wrapper for target->type->run_algorithm.
 358  */
 359 int target_run_algorithm(struct target_s *target,
 360                 int num_mem_params, struct mem_param *mem_params,
 361                 int num_reg_params, struct reg_param *reg_param,
 362                 uint32_t entry_point, uint32_t exit_point,
 363                 int timeout_ms, void *arch_info);
 364
 365 /**
 366  * Read @a count items of @a size bytes from the memory of @a target at
 367  * the @a address given.
 368  *
 369  * This routine is a wrapper for target->type->read_memory.
 370  */
 371 int target_read_memory(struct target_s *target,
 372                 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 373 /**
 374  * Write @a count items of @a size bytes to the memory of @a target at
 375  * the @a address given.
 376  *
 377  * This routine is wrapper for target->type->write_memory.
 378  */
 379 int target_write_memory(struct target_s *target,
 380                 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
 381
 382 /**
 383  * Write @a count items of 4 bytes to the memory of @a target at
 384  * the @a address given.  Because it operates only on whole words,
 385  * this should be faster than target_write_memory().
 386  *
 387  * This routine is wrapper for target->type->bulk_write_memory.
 388  */
 389 int target_bulk_write_memory(struct target_s *target,
 390                 uint32_t address, uint32_t count, uint8_t *buffer);
 391
 392 /*
 393  * Write to target memory using the virtual address.
 394  *
 395  * Note that this fn is used to implement software breakpoints. Targets
 396  * can implement support for software breakpoints to memory marked as read
 397  * only by making this fn write to ram even if it is read only(MMU or
 398  * MPUs).
 399  *
 400  * It is sufficient to implement for writing a single word(16 or 32 in
 401  * ARM32/16 bit case) to write the breakpoint to ram.
 402  *
 403  * The target should also take care of "other things" to make sure that
 404  * software breakpoints can be written using this function. E.g.
 405  * when there is a separate instruction and data cache, this fn must
 406  * make sure that the instruction cache is synced up to the potential
 407  * code change that can happen as a result of the memory write(typically
 408  * by invalidating the cache).
 409  *
 410  * The high level wrapper fn in target.c will break down this memory write
 411  * request to multiple write requests to the target driver to e.g. guarantee
 412  * that writing 4 bytes to an aligned address happens with a single 32 bit
 413  * write operation, thus making this fn suitable to e.g. write to special
 414  * peripheral registers which do not support byte operations.
 415  */
 416 int target_write_buffer(struct target_s *target,
 417                 uint32_t address, uint32_t size, uint8_t *buffer);
 418 int target_read_buffer(struct target_s *target,
 419                 uint32_t address, uint32_t size, uint8_t *buffer);
 420 int target_checksum_memory(struct target_s *target,
 421                 uint32_t address, uint32_t size, uint32_t* crc);
 422 int target_blank_check_memory(struct target_s *target,
 423                 uint32_t address, uint32_t size, uint32_t* blank);
 424 int target_wait_state(target_t *target, enum target_state state, int ms);
 425
 426 /** Return the *name* of this targets current state */
 427 const char *target_state_name( target_t *target );
 428
 429 /* DANGER!!!!!
 430  *
 431  * if "area" passed in to target_alloc_working_area() points to a memory
 432  * location that goes out of scope (e.g. a pointer on the stack), then
 433  * the caller of target_alloc_working_area() is responsible for invoking
 434  * target_free_working_area() before "area" goes out of scope.
 435  *
 436  * target_free_all_working_areas() will NULL out the "area" pointer
 437  * upon resuming or resetting the CPU.
 438  *
 439  */
 440 int target_alloc_working_area(struct target_s *target,
 441                 uint32_t size, struct working_area **area);
 442 int target_free_working_area(struct target_s *target, struct working_area *area);
 443 int target_free_working_area_restore(struct target_s *target,
 444                 struct working_area *area, int restore);
 445 void target_free_all_working_areas(struct target_s *target);
 446 void target_free_all_working_areas_restore(struct target_s *target, int restore);
 447
 448 extern target_t *all_targets;
 449
 450 extern struct target_event_callback *target_event_callbacks;
 451 extern struct target_timer_callback *target_timer_callbacks;
 452
 453 uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer);
 454 uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer);
 455 uint8_t  target_buffer_get_u8 (target_t *target, const uint8_t *buffer);
 456 void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value);
 457 void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value);
 458 void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t  value);
 459
 460 int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value);
 461 int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value);
 462 int target_read_u8(struct target_s *target, uint32_t address, uint8_t *value);
 463 int target_write_u32(struct target_s *target, uint32_t address, uint32_t value);
 464 int target_write_u16(struct target_s *target, uint32_t address, uint16_t value);
 465 int target_write_u8(struct target_s *target, uint32_t address, uint8_t value);
 466
 467 /* Issues USER() statements with target state information */
 468 int target_arch_state(struct target_s *target);
 469
 470 void target_handle_event(target_t *t, enum target_event e);
 471 void target_all_handle_event(enum target_event e);
 472
 473 #define ERROR_TARGET_INVALID    (-300)
 474 #define ERROR_TARGET_INIT_FAILED (-301)
 475 #define ERROR_TARGET_TIMEOUT    (-302)
 476 #define ERROR_TARGET_NOT_HALTED (-304)
 477 #define ERROR_TARGET_FAILURE    (-305)
 478 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 479 #define ERROR_TARGET_DATA_ABORT (-307)
 480 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 481 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 482 #define ERROR_TARGET_NOT_RUNNING (-310)
 483 #define ERROR_TARGET_NOT_EXAMINED (-311)
 484
 485 extern const Jim_Nvp nvp_error_target[];
 486
 487 const char *target_strerror_safe(int err);
 488
 489 #endif /* TARGET_H */