src/target/armv4_5.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2008 by Spencer Oliver                                  *
   6  *   spen@spen-soft.co.uk                                                  *
   7  *                                                                         *
   8  *   Copyright (C) 2009 by Øyvind Harboe                                   *
   9  *   oyvind.harboe@zylin.com                                               *
  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 ARMV4_5_H
  27 #define ARMV4_5_H
  28
  29 #include "target.h"
  30
  31 typedef enum armv4_5_mode
  32 {
  33         ARMV4_5_MODE_USR = 16,
  34         ARMV4_5_MODE_FIQ = 17,
  35         ARMV4_5_MODE_IRQ = 18,
  36         ARMV4_5_MODE_SVC = 19,
  37         ARMV4_5_MODE_ABT = 23,
  38         ARM_MODE_MON = 26,
  39         ARMV4_5_MODE_UND = 27,
  40         ARMV4_5_MODE_SYS = 31,
  41         ARMV4_5_MODE_ANY = -1
  42 } armv4_5_mode_t;
  43
  44 const char *arm_mode_name(unsigned psr_mode);
  45 bool is_arm_mode(unsigned psr_mode);
  46
  47 int armv4_5_mode_to_number(enum armv4_5_mode mode);
  48 enum armv4_5_mode armv4_5_number_to_mode(int number);
  49
  50 typedef enum armv4_5_state
  51 {
  52         ARMV4_5_STATE_ARM,
  53         ARMV4_5_STATE_THUMB,
  54         ARMV4_5_STATE_JAZELLE,
  55         ARM_STATE_THUMB_EE,
  56 } armv4_5_state_t;
  57
  58 extern char* armv4_5_state_strings[];
  59
  60 extern const int armv4_5_core_reg_map[8][17];
  61
  62 #define ARMV4_5_CORE_REG_MODE(cache, mode, num) \
  63                 cache->reg_list[armv4_5_core_reg_map[armv4_5_mode_to_number(mode)][num]]
  64
  65 /* offset into armv4_5 core register cache -- OBSOLETE, DO NOT USE! */
  66 enum { ARMV4_5_CPSR = 31, };
  67
  68 #define ARMV4_5_COMMON_MAGIC 0x0A450A45
  69
  70 /**
  71  * Represents a generic ARM core, with standard application registers.
  72  *
  73  * There are sixteen application registers (including PC, SP, LR) and a PSR.
  74  * Cortex-M series cores do not support as many core states or shadowed
  75  * registers as traditional ARM cores, and only support Thumb2 instructions.
  76  */
  77 struct arm
  78 {
  79         int common_magic;
  80         struct reg_cache *core_cache;
  81
  82         /** Handle to the CPSR; valid in all core modes. */
  83         struct reg *cpsr;
  84
  85         /** Handle to the SPSR; valid only in core modes with an SPSR. */
  86         struct reg *spsr;
  87
  88         const int *map;
  89
  90         /**
  91          * Indicates what registers are in the ARM state core register set.
  92          * ARMV4_5_MODE_ANY indicates the standard set of 37 registers,
  93          * seen on for example ARM7TDMI cores.  ARM_MODE_MON indicates three
  94          * more registers are shadowed, for "Secure Monitor" mode.
  95          */
  96         enum armv4_5_mode core_type;
  97
  98         enum armv4_5_mode core_mode;
  99         enum armv4_5_state core_state;
 100
 101         /** Flag reporting unavailability of the BKPT instruction. */
 102         bool is_armv4;
 103
 104         /** Backpointer to the target. */
 105         struct target *target;
 106
 107         /** Handle for the debug module, if one is present. */
 108         struct arm_dpm *dpm;
 109
 110         /** Handle for the Embedded Trace Module, if one is present. */
 111         struct etm_context *etm;
 112
 113         int (*full_context)(struct target *target);
 114         int (*read_core_reg)(struct target *target, struct reg *reg,
 115                         int num, enum armv4_5_mode mode);
 116         int (*write_core_reg)(struct target *target, struct reg *reg,
 117                         int num, enum armv4_5_mode mode, uint32_t value);
 118         void *arch_info;
 119 };
 120
 121 #define target_to_armv4_5 target_to_arm
 122
 123 /** Convert target handle to generic ARM target state handle. */
 124 static inline struct arm *target_to_arm(struct target *target)
 125 {
 126         return target->arch_info;
 127 }
 128
 129 static inline bool is_arm(struct arm *arm)
 130 {
 131         return arm && arm->common_magic == ARMV4_5_COMMON_MAGIC;
 132 }
 133
 134 struct armv4_5_algorithm
 135 {
 136         int common_magic;
 137
 138         enum armv4_5_mode core_mode;
 139         enum armv4_5_state core_state;
 140 };
 141
 142 struct arm_reg
 143 {
 144         int num;
 145         enum armv4_5_mode mode;
 146         struct target *target;
 147         struct arm *armv4_5_common;
 148         uint32_t value;
 149 };
 150
 151 struct reg_cache* armv4_5_build_reg_cache(struct target *target,
 152                 struct arm *armv4_5_common);
 153
 154 int armv4_5_arch_state(struct target *target);
 155 int armv4_5_get_gdb_reg_list(struct target *target,
 156                 struct reg **reg_list[], int *reg_list_size);
 157
 158 int armv4_5_register_commands(struct command_context *cmd_ctx);
 159 int armv4_5_init_arch_info(struct target *target, struct arm *armv4_5);
 160
 161 int armv4_5_run_algorithm(struct target *target,
 162                 int num_mem_params, struct mem_param *mem_params,
 163                 int num_reg_params, struct reg_param *reg_params,
 164                 uint32_t entry_point, uint32_t exit_point,
 165                 int timeout_ms, void *arch_info);
 166
 167 int arm_checksum_memory(struct target *target,
 168                 uint32_t address, uint32_t count, uint32_t *checksum);
 169 int arm_blank_check_memory(struct target *target,
 170                 uint32_t address, uint32_t count, uint32_t *blank);
 171
 172 void arm_set_cpsr(struct arm *arm, uint32_t cpsr);
 173 struct reg *arm_reg_current(struct arm *arm, unsigned regnum);
 174
 175 extern struct reg arm_gdb_dummy_fp_reg;
 176 extern struct reg arm_gdb_dummy_fps_reg;
 177
 178 /* ARM mode instructions
 179  */
 180
 181 /* Store multiple increment after
 182  * Rn: base register
 183  * List: for each bit in list: store register
 184  * S: in priviledged mode: store user-mode registers
 185  * W = 1: update the base register. W = 0: leave the base register untouched
 186  */
 187 #define ARMV4_5_STMIA(Rn, List, S, W)   (0xe8800000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
 188
 189 /* Load multiple increment after
 190  * Rn: base register
 191  * List: for each bit in list: store register
 192  * S: in priviledged mode: store user-mode registers
 193  * W = 1: update the base register. W = 0: leave the base register untouched
 194  */
 195 #define ARMV4_5_LDMIA(Rn, List, S, W)   (0xe8900000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
 196
 197 /* MOV r8, r8 */
 198 #define ARMV4_5_NOP                                     (0xe1a08008)
 199
 200 /* Move PSR to general purpose register
 201  * R = 1: SPSR R = 0: CPSR
 202  * Rn: target register
 203  */
 204 #define ARMV4_5_MRS(Rn, R)                      (0xe10f0000 | ((R) << 22) | ((Rn) << 12))
 205
 206 /* Store register
 207  * Rd: register to store
 208  * Rn: base register
 209  */
 210 #define ARMV4_5_STR(Rd, Rn)                     (0xe5800000 | ((Rd) << 12) | ((Rn) << 16))
 211
 212 /* Load register
 213  * Rd: register to load
 214  * Rn: base register
 215  */
 216 #define ARMV4_5_LDR(Rd, Rn)                     (0xe5900000 | ((Rd) << 12) | ((Rn) << 16))
 217
 218 /* Move general purpose register to PSR
 219  * R = 1: SPSR R = 0: CPSR
 220  * Field: Field mask
 221  * 1: control field 2: extension field 4: status field 8: flags field
 222  * Rm: source register
 223  */
 224 #define ARMV4_5_MSR_GP(Rm, Field, R)    (0xe120f000 | (Rm) | ((Field) << 16) | ((R) << 22))
 225 #define ARMV4_5_MSR_IM(Im, Rotate, Field, R)    (0xe320f000 | (Im)  | ((Rotate) << 8) | ((Field) << 16) | ((R) << 22))
 226
 227 /* Load Register Halfword Immediate Post-Index
 228  * Rd: register to load
 229  * Rn: base register
 230  */
 231 #define ARMV4_5_LDRH_IP(Rd, Rn) (0xe0d000b2 | ((Rd) << 12) | ((Rn) << 16))
 232
 233 /* Load Register Byte Immediate Post-Index
 234  * Rd: register to load
 235  * Rn: base register
 236  */
 237 #define ARMV4_5_LDRB_IP(Rd, Rn) (0xe4d00001 | ((Rd) << 12) | ((Rn) << 16))
 238
 239 /* Store register Halfword Immediate Post-Index
 240  * Rd: register to store
 241  * Rn: base register
 242  */
 243 #define ARMV4_5_STRH_IP(Rd, Rn) (0xe0c000b2 | ((Rd) << 12) | ((Rn) << 16))
 244
 245 /* Store register Byte Immediate Post-Index
 246  * Rd: register to store
 247  * Rn: base register
 248  */
 249 #define ARMV4_5_STRB_IP(Rd, Rn) (0xe4c00001 | ((Rd) << 12) | ((Rn) << 16))
 250
 251 /* Branch (and Link)
 252  * Im: Branch target (left-shifted by 2 bits, added to PC)
 253  * L: 1: branch and link 0: branch only
 254  */
 255 #define ARMV4_5_B(Im, L) (0xea000000 | (Im) | ((L) << 24))
 256
 257 /* Branch and exchange (ARM state)
 258  * Rm: register holding branch target address
 259  */
 260 #define ARMV4_5_BX(Rm) (0xe12fff10 | (Rm))
 261
 262 /* Move to ARM register from coprocessor
 263  * CP: Coprocessor number
 264  * op1: Coprocessor opcode
 265  * Rd: destination register
 266  * CRn: first coprocessor operand
 267  * CRm: second coprocessor operand
 268  * op2: Second coprocessor opcode
 269  */
 270 #define ARMV4_5_MRC(CP, op1, Rd, CRn, CRm, op2) (0xee100010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
 271
 272 /* Move to coprocessor from ARM register
 273  * CP: Coprocessor number
 274  * op1: Coprocessor opcode
 275  * Rd: destination register
 276  * CRn: first coprocessor operand
 277  * CRm: second coprocessor operand
 278  * op2: Second coprocessor opcode
 279  */
 280 #define ARMV4_5_MCR(CP, op1, Rd, CRn, CRm, op2) (0xee000010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
 281
 282 /* Breakpoint instruction (ARMv5)
 283  * Im: 16-bit immediate
 284  */
 285 #define ARMV5_BKPT(Im) (0xe1200070 | ((Im & 0xfff0) << 8) | (Im & 0xf))
 286
 287
 288 /* Thumb mode instructions
 289  */
 290
 291 /* Store register (Thumb mode)
 292  * Rd: source register
 293  * Rn: base register
 294  */
 295 #define ARMV4_5_T_STR(Rd, Rn)   ((0x6000 | (Rd) | ((Rn) << 3)) | ((0x6000 | (Rd) | ((Rn) << 3)) << 16))
 296
 297 /* Load register (Thumb state)
 298  * Rd: destination register
 299  * Rn: base register
 300  */
 301 #define ARMV4_5_T_LDR(Rd, Rn)   ((0x6800 | ((Rn) << 3) | (Rd)) | ((0x6800 | ((Rn) << 3) | (Rd)) << 16))
 302
 303 /* Load multiple (Thumb state)
 304  * Rn: base register
 305  * List: for each bit in list: store register
 306  */
 307 #define ARMV4_5_T_LDMIA(Rn, List) ((0xc800 | ((Rn) << 8) | (List)) | ((0xc800 | ((Rn) << 8) | List) << 16))
 308
 309 /* Load register with PC relative addressing
 310  * Rd: register to load
 311  */
 312 #define ARMV4_5_T_LDR_PCREL(Rd) ((0x4800 | ((Rd) << 8)) | ((0x4800 | ((Rd) << 8)) << 16))
 313
 314 /* Move hi register (Thumb mode)
 315  * Rd: destination register
 316  * Rm: source register
 317  */
 318 #define ARMV4_5_T_MOV(Rd, Rm)   ((0x4600 | ((Rd) & 0x7) | (((Rd) & 0x8) << 4) | (((Rm) & 0x7) << 3) | (((Rm) & 0x8) << 3)) | ((0x4600 | ((Rd) & 0x7) | (((Rd) & 0x8) << 4) | (((Rm) & 0x7) << 3) | (((Rm) & 0x8) << 3)) << 16))
 319
 320 /* No operation (Thumb mode)
 321  */
 322 #define ARMV4_5_T_NOP   (0x46c0 | (0x46c0 << 16))
 323
 324 /* Move immediate to register (Thumb state)
 325  * Rd: destination register
 326  * Im: 8-bit immediate value
 327  */
 328 #define ARMV4_5_T_MOV_IM(Rd, Im)        ((0x2000 | ((Rd) << 8) | (Im)) | ((0x2000 | ((Rd) << 8) | (Im)) << 16))
 329
 330 /* Branch and Exchange
 331  * Rm: register containing branch target
 332  */
 333 #define ARMV4_5_T_BX(Rm)                ((0x4700 | ((Rm) << 3)) | ((0x4700 | ((Rm) << 3)) << 16))
 334
 335 /* Branch (Thumb state)
 336  * Imm: Branch target
 337  */
 338 #define ARMV4_5_T_B(Imm)        ((0xe000 | (Imm)) | ((0xe000 | (Imm)) << 16))
 339
 340 /* Breakpoint instruction (ARMv5) (Thumb state)
 341  * Im: 8-bit immediate
 342  */
 343 #define ARMV5_T_BKPT(Im) ((0xbe00 | Im) | ((0xbe00 | Im) << 16))
 344
 345 /* build basic mrc/mcr opcode */
 346
 347 static inline uint32_t mrc_opcode(int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
 348 {
 349         uint32_t t = 0;
 350         t|=op1<<21;
 351         t|=op2<<5;
 352         t|=CRn<<16;
 353         t|=CRm<<0;
 354         return t;
 355 }
 356
 357 #endif /* ARMV4_5_H */