src/target/target.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Ø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 "register.h"
  30 #include "breakpoints.h"
  31 #include "algorithm.h"
  32 #include "trace.h"
  33
  34 #include "command.h"
  35 #include "types.h"
  36
  37 #include <sys/time.h>
  38 #include <time.h>
  39
  40 struct reg_s;
  41 struct command_context_s;
  42 /*
  43 TARGET_UNKNOWN = 0: we don't know anything about the target yet
  44 TARGET_RUNNING = 1: the target is executing user code
  45 TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  46 debugger. on an xscale it means that the debug handler is executing
  47 TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
  48 not sure how this is used with all the recent changes)
  49 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
  50 behalf of the debugger (e.g. algorithm for flashing)
  51 */
  52 enum target_state
  53 {
  54         TARGET_UNKNOWN = 0,
  55         TARGET_RUNNING = 1,
  56         TARGET_HALTED = 2,
  57         TARGET_RESET = 3,
  58         TARGET_DEBUG_RUNNING = 4,
  59 };
  60
  61 extern const Jim_Nvp nvp_target_state[];
  62
  63 enum nvp_assert {
  64         NVP_DEASSERT,
  65         NVP_ASSERT,
  66 };
  67
  68 extern const Jim_Nvp nvp_assert[];
  69
  70 enum target_reset_mode
  71 {
  72         RESET_UNKNOWN = 0,
  73         RESET_RUN = 1,          /* reset and let target run */
  74         RESET_HALT = 2,         /* reset and halt target out of reset */
  75         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
  76 };
  77
  78 extern const Jim_Nvp nvp_reset_mode[];
  79
  80 enum target_debug_reason
  81 {
  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_UNDEFINED = 6
  89 };
  90
  91 extern const Jim_Nvp nvp_target_debug_reason[];
  92
  93 enum target_endianess
  94 {
  95         TARGET_ENDIAN_UNKNOWN=0,
  96         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
  97 };
  98
  99 extern const Jim_Nvp nvp_target_endian[];
 100
 101 struct target_s;
 102
 103 typedef struct working_area_s
 104 {
 105         u32 address;
 106         u32 size;
 107         int free;
 108         u8 *backup;
 109         struct working_area_s **user;
 110         struct working_area_s *next;
 111 } working_area_t;
 112
 113 typedef struct target_type_s
 114 {
 115         char *name;
 116
 117         int examined;
 118
 119         /* poll current target status */
 120         int (*poll)(struct target_s *target);
 121         /* Invoked only from target_arch_state().
 122          * Issue USER() w/architecture specific status.  */
 123         int (*arch_state)(struct target_s *target);
 124
 125         /* target request support */
 126         int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
 127
 128         /* halt will log a warning, but return ERROR_OK if the target is already halted. */
 129         int (*halt)(struct target_s *target);
 130         int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 131         int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
 132
 133         /* target reset control. assert reset can be invoked when OpenOCD and
 134          * the target is out of sync.
 135          *
 136          * A typical example is that the target was power cycled while OpenOCD
 137          * thought the target was halted or running.
 138          *
 139          * assert_reset() can therefore make no assumptions whatsoever about the
 140          * state of the target
 141          *
 142          * Before assert_reset() for the target is invoked, a TRST/tms and
 143          * chain validation is executed. TRST should not be asserted
 144          * during target assert unless there is no way around it due to
 145          * the way reset's are configured.
 146          *
 147          */
 148         int (*assert_reset)(struct target_s *target);
 149         int (*deassert_reset)(struct target_s *target);
 150         int (*soft_reset_halt_imp)(struct target_s *target);
 151         int (*soft_reset_halt)(struct target_s *target);
 152
 153         /* target register access for gdb.
 154          *
 155          * Danger! this function will succeed even if the target is running
 156          * and return a register list with dummy values.
 157          *
 158          * The reason is that GDB connection will fail without a valid register
 159          * list, however it is after GDB is connected that monitor commands can
 160          * be run to properly initialize the target
 161          */
 162         int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
 163
 164         /* target memory access
 165         * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
 166         * count: number of items of <size>
 167         */
 168         int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 169         int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 170         int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 171         int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 172
 173         /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
 174         int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
 175
 176         int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
 177         int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
 178
 179         /*
 180          * target break-/watchpoint control
 181          * rw: 0 = write, 1 = read, 2 = access
 182          *
 183          * Target must be halted while this is invoked as this
 184          * will actually set up breakpoints on target.
 185          *
 186          * The breakpoint hardware will be set up upon adding the first breakpoint.
 187          *
 188          * Upon GDB connection all breakpoints/watchpoints are cleared.
 189          */
 190         int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 191
 192         /* remove breakpoint. hw will only be updated if the target is currently halted.
 193          * However, this method can be invoked on unresponsive targets.
 194          */
 195         int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
 196         int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 197         /* remove watchpoint. hw will only be updated if the target is currently halted.
 198          * However, this method can be invoked on unresponsive targets.
 199          */
 200         int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
 201
 202         /* target algorithm support */
 203         int (*run_algorithm_imp)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
 204         int (*run_algorithm)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
 205
 206         int (*register_commands)(struct command_context_s *cmd_ctx);
 207
 208         /* called when target is created */
 209         int (*target_create)( struct target_s *target, Jim_Interp *interp );
 210
 211         /* called for various config parameters */
 212         /* returns JIM_CONTINUE - if option not understood */
 213         /* otherwise: JIM_OK, or JIM_ERR, */
 214         int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
 215
 216         /* target commands specifically handled by the target */
 217         /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
 218         int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
 219
 220         /* invoked after JTAG chain has been examined & validated. During
 221          * this stage the target is examined and any additional setup is
 222          * performed.
 223          *
 224          * invoked every time after the jtag chain has been validated/examined
 225          */
 226         int (*examine)(struct target_s *target);
 227         /* Set up structures for target.
 228          *
 229          * It is illegal to talk to the target at this stage as this fn is invoked
 230          * before the JTAG chain has been examined/verified
 231      */
 232         int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
 233         int (*quit)(void);
 234
 235         int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
 236         int (*mmu)(struct target_s *target, int *enabled);
 237
 238 } target_type_t;
 239
 240 // forward decloration
 241 typedef struct target_event_action_s target_event_action_t;
 242
 243 typedef struct target_s
 244 {
 245         target_type_t *type;                            /* target type definition (name, access functions) */
 246         const char *cmd_name;               /* tcl Name of target */
 247         int target_number;                  /* generaly, target index but may not be in order */
 248         int chain_position;                 /* where on the jtag chain is this */
 249         const char *variant;                /* what varient of this chip is it? */
 250         target_event_action_t *event_action;
 251
 252         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
 253         u32 working_area;                                       /* working area (initialized RAM). Evaluated
 254                                                                                    upon first allocation from virtual/physical address. */
 255         u32 working_area_virt;                          /* virtual address */
 256         u32 working_area_phys;                          /* physical address */
 257         u32 working_area_size;                          /* size in bytes */
 258         u32 backup_working_area;                        /* whether the content of the working area has to be preserved */
 259         struct working_area_s *working_areas;/* list of allocated working areas */
 260         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
 261         enum target_endianess endianness;       /* target endianess */
 262         enum target_state state;                        /* the current backend-state (running, halted, ...) */
 263         struct reg_cache_s *reg_cache;          /* the first register cache of the target (core regs) */
 264         struct breakpoint_s *breakpoints;       /* list of breakpoints */
 265         struct watchpoint_s *watchpoints;       /* list of watchpoints */
 266         struct trace_s *trace_info;                     /* generic trace information */
 267         struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
 268         u32 dbg_msg_enabled;                            /* debug message status */
 269         void *arch_info;                                        /* architecture specific information */
 270         struct target_s *next;                          /* next target in list */
 271
 272         int display;                                            /* display async info in telnet session. Do not display
 273                                                                                    lots of halted/resumed info when stepping in debugger. */
 274 } target_t;
 275
 276 enum target_event
 277 {
 278         // OLD historical names
 279         //  - Prior to the great TCL change
 280         //  - June/July/Aug 2008
 281         //  - Duane Ellis
 282         TARGET_EVENT_OLD_gdb_program_config,
 283         TARGET_EVENT_OLD_pre_reset,
 284         TARGET_EVENT_OLD_post_reset,
 285         TARGET_EVENT_OLD_pre_resume,
 286
 287         /* allow GDB to do stuff before others handle the halted event,
 288         this is in lieu of defining ordering of invocation of events,
 289         which would be more complicated */
 290         TARGET_EVENT_EARLY_HALTED,
 291         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
 292         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
 293         TARGET_EVENT_RESUME_START,
 294         TARGET_EVENT_RESUME_END,
 295
 296         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
 297         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
 298
 299         TARGET_EVENT_RESET_START,
 300         TARGET_EVENT_RESET_ASSERT_PRE,
 301         TARGET_EVENT_RESET_ASSERT_POST,
 302         TARGET_EVENT_RESET_DEASSERT_PRE,
 303         TARGET_EVENT_RESET_DEASSERT_POST,
 304         TARGET_EVENT_RESET_HALT_PRE,
 305         TARGET_EVENT_RESET_HALT_POST,
 306         TARGET_EVENT_RESET_WAIT_PRE,
 307         TARGET_EVENT_RESET_WAIT_POST,
 308         TARGET_EVENT_RESET_INIT,
 309         TARGET_EVENT_RESET_END,
 310
 311
 312         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
 313         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 314
 315         TARGET_EVENT_EXAMINE_START,
 316         TARGET_EVENT_EXAMINE_END,
 317
 318
 319         TARGET_EVENT_GDB_ATTACH,
 320         TARGET_EVENT_GDB_DETACH,
 321
 322         TARGET_EVENT_GDB_FLASH_ERASE_START,
 323         TARGET_EVENT_GDB_FLASH_ERASE_END,
 324         TARGET_EVENT_GDB_FLASH_WRITE_START,
 325         TARGET_EVENT_GDB_FLASH_WRITE_END,
 326 };
 327
 328 extern const Jim_Nvp nvp_target_event[];
 329
 330 struct target_event_action_s {
 331         enum target_event event;
 332         Jim_Obj *body;
 333         int      has_percent;
 334         target_event_action_t *next;
 335  };
 336
 337 typedef struct target_event_callback_s
 338 {
 339         int (*callback)(struct target_s *target, enum target_event event, void *priv);
 340         void *priv;
 341         struct target_event_callback_s *next;
 342 } target_event_callback_t;
 343
 344 typedef struct target_timer_callback_s
 345 {
 346         int (*callback)(void *priv);
 347         int time_ms;
 348         int periodic;
 349         struct timeval when;
 350         void *priv;
 351         struct target_timer_callback_s *next;
 352 } target_timer_callback_t;
 353
 354 extern int target_register_commands(struct command_context_s *cmd_ctx);
 355 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
 356 extern int target_init(struct command_context_s *cmd_ctx);
 357 extern int target_examine(void);
 358 extern int handle_target(void *priv);
 359 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
 360
 361 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 362 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
 363 extern int target_poll(target_t *target);
 364 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 365 extern int target_halt(target_t *target);
 366 extern int target_call_event_callbacks(target_t *target, enum target_event event);
 367
 368 /* The period is very approximate, the callback can happen much more often
 369  * or much more rarely than specified
 370  */
 371 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
 372 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
 373 extern int target_call_timer_callbacks(void);
 374 /* invoke this to ensure that e.g. polling timer callbacks happen before
 375  * a syncrhonous command completes.
 376  */
 377 extern int target_call_timer_callbacks_now(void);
 378
 379 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
 380 extern int get_num_by_target(target_t *query_target);
 381 extern target_t* get_target_by_num(int num);
 382
 383 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 384 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
 385 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
 386 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
 387 extern int target_wait_state(target_t *target, enum target_state state, int ms);
 388
 389 /* DANGER!!!!!
 390  *
 391  * if "area" passed in to target_alloc_working_area() points to a memory
 392  * location that goes out of scope (e.g. a pointer on the stack), then
 393  * the caller of target_alloc_working_area() is responsible for invoking
 394  * target_free_working_area() before "area" goes out of scope.
 395  *
 396  * target_free_all_working_areas() will NULL out the "area" pointer
 397  * upon resuming or resetting the CPU.
 398  *
 399  */
 400 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
 401 extern int target_free_working_area(struct target_s *target, working_area_t *area);
 402 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
 403 extern void target_free_all_working_areas(struct target_s *target);
 404 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
 405
 406 extern target_t *all_targets;
 407
 408 extern target_event_callback_t *target_event_callbacks;
 409 extern target_timer_callback_t *target_timer_callbacks;
 410
 411 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
 412 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
 413 extern u8  target_buffer_get_u8 (target_t *target, u8 *buffer);
 414 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
 415 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
 416 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8  value);
 417
 418 int target_read_u32(struct target_s *target, u32 address, u32 *value);
 419 int target_read_u16(struct target_s *target, u32 address, u16 *value);
 420 int target_read_u8(struct target_s *target, u32 address, u8 *value);
 421 int target_write_u32(struct target_s *target, u32 address, u32 value);
 422 int target_write_u16(struct target_s *target, u32 address, u16 value);
 423 int target_write_u8(struct target_s *target, u32 address, u8 value);
 424
 425 /* Issues USER() statements with target state information */
 426 int target_arch_state(struct target_s *target);
 427
 428 void target_handle_event( target_t *t, enum target_event e);
 429 void target_all_handle_event( enum target_event e );
 430
 431
 432 #define ERROR_TARGET_INVALID    (-300)
 433 #define ERROR_TARGET_INIT_FAILED (-301)
 434 #define ERROR_TARGET_TIMEOUT    (-302)
 435 #define ERROR_TARGET_NOT_HALTED (-304)
 436 #define ERROR_TARGET_FAILURE    (-305)
 437 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
 438 #define ERROR_TARGET_DATA_ABORT (-307)
 439 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
 440 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
 441 #define ERROR_TARGET_NOT_RUNNING (-310)
 442 #define ERROR_TARGET_NOT_EXAMINED (-311)
 443
 444 extern const Jim_Nvp nvp_error_target[];
 445 extern const char *target_strerror_safe( int err );
 446
 447 #endif /* TARGET_H */