src/target/arm11.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 digenius technology GmbH.                          *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  18  ***************************************************************************/
  19
  20 #ifndef ARM11_H
  21 #define ARM11_H
  22
  23 #include "target.h"
  24 #include "register.h"
  25 #include "embeddedice.h"
  26 #include "arm_jtag.h"
  27 #include <stdbool.h>
  28
  29
  30 #define asizeof(x)      (sizeof(x) / sizeof((x)[0]))
  31
  32 #define NEW(type, variable, items)                      \
  33     type * variable = calloc(1, sizeof(type) * items)
  34
  35
  36 /* For MinGW use 'I' prefix to print size_t (instead of 'z') */
  37
  38 #ifndef __MSVCRT__
  39 #define ZU              "%zu"
  40 #else
  41 #define ZU              "%Iu"
  42 #endif
  43
  44
  45 #define ARM11_REGCACHE_MODEREGS         0
  46 #define ARM11_REGCACHE_FREGS            0
  47
  48 #define ARM11_REGCACHE_COUNT            (20 +                                   \
  49                                          23 * ARM11_REGCACHE_MODEREGS +         \
  50                                           9 * ARM11_REGCACHE_FREGS)
  51
  52
  53 typedef struct arm11_register_history_s
  54 {
  55     u32     value;
  56     u8      valid;
  57 }arm11_register_history_t;
  58
  59 enum arm11_debug_version
  60 {
  61     ARM11_DEBUG_V6      = 0x01,
  62     ARM11_DEBUG_V61     = 0x02,
  63     ARM11_DEBUG_V7      = 0x03,
  64     ARM11_DEBUG_V7_CP14 = 0x04,
  65 };
  66
  67 typedef struct arm11_common_s
  68 {
  69     target_t *  target;
  70
  71     arm_jtag_t  jtag_info;
  72
  73     /** \name Processor type detection */
  74     /*@{*/
  75
  76     u32         device_id;          /**< IDCODE readout                         */
  77     u32         didr;               /**< DIDR readout (debug capabilities)      */
  78     u8          implementor;        /**< DIDR Implementor readout               */
  79
  80     size_t      brp;                /**< Number of Breakpoint Register Pairs from DIDR  */
  81     size_t      wrp;                /**< Number of Watchpoint Register Pairs from DIDR  */
  82
  83     enum arm11_debug_version
  84                 debug_version;      /**< ARM debug architecture from DIDR       */
  85     /*@}*/
  86
  87
  88     u32         last_dscr;          /**< Last retrieved DSCR value;
  89                                      *   Can be used to detect changes          */
  90
  91     bool        trst_active;
  92     bool        halt_requested;
  93     bool        simulate_reset_on_next_halt;
  94
  95     /** \name Shadow registers to save processor state */
  96     /*@{*/
  97
  98     reg_t *     reg_list;                               /**< target register list */
  99     u32         reg_values[ARM11_REGCACHE_COUNT];       /**< data for registers */
 100
 101     /*@}*/
 102
 103     arm11_register_history_t
 104                 reg_history[ARM11_REGCACHE_COUNT];      /**< register state before last resume */
 105
 106
 107     size_t      free_brps;                              /**< keep track of breakpoints allocated by arm11_add_breakpoint() */
 108     size_t      free_wrps;                              /**< keep track of breakpoints allocated by arm11_add_watchpoint() */
 109
 110 } arm11_common_t;
 111
 112
 113 /**
 114  * ARM11 DBGTAP instructions
 115  *
 116  * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
 117  */
 118 enum arm11_instructions
 119 {
 120     ARM11_EXTEST    = 0x00,
 121     ARM11_SCAN_N    = 0x02,
 122     ARM11_RESTART   = 0x04,
 123     ARM11_HALT      = 0x08,
 124     ARM11_INTEST    = 0x0C,
 125     ARM11_ITRSEL    = 0x1D,
 126     ARM11_IDCODE    = 0x1E,
 127     ARM11_BYPASS    = 0x1F,
 128 };
 129
 130 enum arm11_dscr
 131 {
 132     ARM11_DSCR_CORE_HALTED                              = 1 << 0,
 133     ARM11_DSCR_CORE_RESTARTED                           = 1 << 1,
 134
 135     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK               = 0x0F << 2,
 136     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT               = 0x00 << 2,
 137     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT         = 0x01 << 2,
 138     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT         = 0x02 << 2,
 139     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION   = 0x03 << 2,
 140     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ             = 0x04 << 2,
 141     ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH       = 0x05 << 2,
 142
 143     ARM11_DSCR_STICKY_PRECISE_DATA_ABORT                = 1 << 6,
 144     ARM11_DSCR_STICKY_IMPRECISE_DATA_ABORT              = 1 << 7,
 145     ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE           = 1 << 13,
 146     ARM11_DSCR_MODE_SELECT                              = 1 << 14,
 147     ARM11_DSCR_WDTR_FULL                                = 1 << 29,
 148     ARM11_DSCR_RDTR_FULL                                = 1 << 30,
 149 };
 150
 151 enum arm11_cpsr
 152 {
 153     ARM11_CPSR_T                                = 1 << 5,
 154     ARM11_CPSR_J                                = 1 << 24,
 155 };
 156
 157 enum arm11_sc7
 158 {
 159     ARM11_SC7_NULL                              = 0,
 160     ARM11_SC7_VCR                               = 7,
 161     ARM11_SC7_PC                                = 8,
 162     ARM11_SC7_BVR0                              = 64,
 163     ARM11_SC7_BCR0                              = 80,
 164     ARM11_SC7_WVR0                              = 96,
 165     ARM11_SC7_WCR0                              = 112,
 166 };
 167
 168
 169
 170 typedef struct arm11_reg_state_s
 171 {
 172     u32                         def_index;
 173     target_t *                  target;
 174 } arm11_reg_state_t;
 175
 176
 177
 178
 179 /* poll current target status */
 180 int arm11_poll(struct target_s *target);
 181 /* architecture specific status reply */
 182 int arm11_arch_state(struct target_s *target);
 183
 184 /* target request support */
 185 int arm11_target_request_data(struct target_s *target, u32 size, u8 *buffer);
 186
 187 /* target execution control */
 188 int arm11_halt(struct target_s *target);
 189 int arm11_resume(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
 190 int arm11_step(struct target_s *target, int current, u32 address, int handle_breakpoints);
 191
 192 /* target reset control */
 193 int arm11_assert_reset(struct target_s *target);
 194 int arm11_deassert_reset(struct target_s *target);
 195 int arm11_soft_reset_halt(struct target_s *target);
 196 int arm11_prepare_reset_halt(struct target_s *target);
 197
 198 /* target register access for gdb */
 199 int arm11_get_gdb_reg_list(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
 200
 201 /* target memory access
 202 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
 203 * count: number of items of <size>
 204 */
 205 int arm11_read_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 206 int arm11_write_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
 207
 208 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
 209 int arm11_bulk_write_memory(struct target_s *target, u32 address, u32 count, u8 *buffer);
 210
 211 int arm11_checksum_memory(struct target_s *target, u32 address, u32 count, u32* checksum);
 212
 213 /* target break-/watchpoint control
 214 * rw: 0 = write, 1 = read, 2 = access
 215 */
 216 int arm11_add_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
 217 int arm11_remove_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
 218 int arm11_add_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
 219 int arm11_remove_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
 220
 221 /* target algorithm support */
 222 int arm11_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);
 223
 224 int arm11_register_commands(struct command_context_s *cmd_ctx);
 225 int arm11_target_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
 226 int arm11_init_target(struct command_context_s *cmd_ctx, struct target_s *target);
 227 int arm11_quit(void);
 228
 229
 230 /* helpers */
 231 void arm11_build_reg_cache(target_t *target);
 232
 233 void arm11_record_register_history(arm11_common_t * arm11);
 234 void arm11_dump_reg_changes(arm11_common_t * arm11);
 235
 236
 237 /* internals */
 238
 239 void arm11_setup_field          (arm11_common_t * arm11, int num_bits, void * in_data, void * out_data, scan_field_t * field);
 240 void arm11_add_IR               (arm11_common_t * arm11, u8 instr, enum tap_state state);
 241 void arm11_add_debug_SCAN_N     (arm11_common_t * arm11, u8 chain, enum tap_state state);
 242 void arm11_add_debug_INST       (arm11_common_t * arm11, u32 inst, u8 * flag, enum tap_state state);
 243 u32  arm11_read_DSCR            (arm11_common_t * arm11);
 244 void arm11_write_DSCR           (arm11_common_t * arm11, u32 dscr);
 245
 246 enum target_debug_reason arm11_get_DSCR_debug_reason(u32 dscr);
 247
 248 void arm11_run_instr_data_prepare               (arm11_common_t * arm11);
 249 void arm11_run_instr_data_finish                (arm11_common_t * arm11);
 250 void arm11_run_instr_no_data                    (arm11_common_t * arm11, u32 * opcode, size_t count);
 251 void arm11_run_instr_no_data1                   (arm11_common_t * arm11, u32 opcode);
 252 void arm11_run_instr_data_to_core               (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
 253 void arm11_run_instr_data_to_core_noack         (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
 254 void arm11_run_instr_data_to_core1              (arm11_common_t * arm11, u32 opcode, u32 data);
 255 void arm11_run_instr_data_from_core             (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
 256 void arm11_run_instr_data_from_core_via_r0      (arm11_common_t * arm11, u32 opcode, u32 * data);
 257 void arm11_run_instr_data_to_core_via_r0        (arm11_common_t * arm11, u32 opcode, u32 data);
 258
 259 int arm11_add_dr_scan_vc(int num_fields, scan_field_t *fields, enum tap_state state);
 260 int arm11_add_ir_scan_vc(int num_fields, scan_field_t *fields, enum tap_state state);
 261
 262
 263 /** Used to make a list of read/write commands for scan chain 7
 264  *
 265  *  Use with arm11_sc7_run()
 266  */
 267 typedef struct arm11_sc7_action_s
 268 {
 269     bool    write;                              /**< Access mode: true for write, false for read.       */
 270     u8      address;                            /**< Register address mode. Use enum #arm11_sc7         */
 271     u32     value;                              /**< If write then set this to value to be written.
 272                                                      In read mode this receives the read value when the
 273                                                      function returns.                                  */
 274 } arm11_sc7_action_t;
 275
 276 void arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t count);
 277
 278 /* Mid-level helper functions */
 279 void arm11_sc7_clear_vbw(arm11_common_t * arm11);
 280 void arm11_sc7_set_vcr(arm11_common_t * arm11, u32 value);
 281
 282 void arm11_read_memory_word(arm11_common_t * arm11, u32 address, u32 * result);
 283
 284
 285
 286 #endif /* ARM11_H */