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