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 "register.h"
  30 #include "target.h"
  31 #include "log.h"
  32
  33 typedef enum armv4_5_mode
  34 {
  35         ARMV4_5_MODE_USR = 16,
  36         ARMV4_5_MODE_FIQ = 17,
  37         ARMV4_5_MODE_IRQ = 18,
  38         ARMV4_5_MODE_SVC = 19,
  39         ARMV4_5_MODE_ABT = 23,
  40         ARMV4_5_MODE_UND = 27,
  41         ARMV4_5_MODE_SYS = 31,
  42         ARMV4_5_MODE_ANY = -1
  43 } armv4_5_mode_t;
  44
  45 extern char** armv4_5_mode_strings;
  46
  47 typedef enum armv4_5_state
  48 {
  49         ARMV4_5_STATE_ARM,
  50         ARMV4_5_STATE_THUMB,
  51         ARMV4_5_STATE_JAZELLE,
  52 } armv4_5_state_t;
  53
  54 extern char* armv4_5_state_strings[];
  55
  56 extern int armv4_5_core_reg_map[7][17];
  57
  58 #define ARMV4_5_CORE_REG_MODE(cache, mode, num) \
  59                 cache->reg_list[armv4_5_core_reg_map[armv4_5_mode_to_number(mode)][num]]
  60 #define ARMV4_5_CORE_REG_MODENUM(cache, mode, num) \
  61                 cache->reg_list[armv4_5_core_reg_map[mode][num]]
  62
  63 /* offsets into armv4_5 core register cache */
  64 enum
  65 {
  66         ARMV4_5_CPSR = 31,
  67         ARMV4_5_SPSR_FIQ = 32,
  68         ARMV4_5_SPSR_IRQ = 33,
  69         ARMV4_5_SPSR_SVC = 34,
  70         ARMV4_5_SPSR_ABT = 35,
  71         ARMV4_5_SPSR_UND = 36
  72 };
  73
  74 #define ARMV4_5_COMMON_MAGIC 0x0A450A45
  75
  76 typedef struct armv4_5_common_s
  77 {
  78         int common_magic;
  79         reg_cache_t *core_cache;
  80         int /* armv4_5_mode */ core_mode;
  81         enum armv4_5_state core_state;
  82         bool is_armv4;
  83         int (*full_context)(struct target_s *target);
  84         int (*read_core_reg)(struct target_s *target, int num, enum armv4_5_mode mode);
  85         int (*write_core_reg)(struct target_s *target, int num, enum armv4_5_mode mode, uint32_t value);
  86         void *arch_info;
  87 } armv4_5_common_t;
  88
  89 static inline struct armv4_5_common_s *
  90 target_to_armv4_5(struct target_s *target)
  91 {
  92         return target->arch_info;
  93 }
  94
  95 typedef struct armv4_5_algorithm_s
  96 {
  97         int common_magic;
  98
  99         enum armv4_5_mode core_mode;
 100         enum armv4_5_state core_state;
 101 } armv4_5_algorithm_t;
 102
 103 typedef struct armv4_5_core_reg_s
 104 {
 105         int num;
 106         enum armv4_5_mode mode;
 107         target_t *target;
 108         armv4_5_common_t *armv4_5_common;
 109 } armv4_5_core_reg_t;
 110
 111 reg_cache_t* armv4_5_build_reg_cache(target_t *target,
 112                 armv4_5_common_t *armv4_5_common);
 113
 114 /* map psr mode bits to linear number */
 115 static __inline int armv4_5_mode_to_number(enum armv4_5_mode mode)
 116 {
 117         switch (mode)
 118         {
 119                 case ARMV4_5_MODE_USR: return 0; break;
 120                 case ARMV4_5_MODE_FIQ: return 1; break;
 121                 case ARMV4_5_MODE_IRQ: return 2; break;
 122                 case ARMV4_5_MODE_SVC: return 3; break;
 123                 case ARMV4_5_MODE_ABT: return 4; break;
 124                 case ARMV4_5_MODE_UND: return 5; break;
 125                 case ARMV4_5_MODE_SYS: return 6; break;
 126                 case ARMV4_5_MODE_ANY: return 0; break; /* map MODE_ANY to user mode */
 127                 default:
 128                         LOG_ERROR("invalid mode value encountered %d", mode);
 129                         return -1;
 130         }
 131 }
 132
 133 /* map linear number to mode bits */
 134 static __inline enum armv4_5_mode armv4_5_number_to_mode(int number)
 135 {
 136         switch (number)
 137         {
 138                 case 0: return ARMV4_5_MODE_USR; break;
 139                 case 1: return ARMV4_5_MODE_FIQ; break;
 140                 case 2: return ARMV4_5_MODE_IRQ; break;
 141                 case 3: return ARMV4_5_MODE_SVC; break;
 142                 case 4: return ARMV4_5_MODE_ABT; break;
 143                 case 5: return ARMV4_5_MODE_UND; break;
 144                 case 6: return ARMV4_5_MODE_SYS; break;
 145                 default:
 146                         LOG_ERROR("mode index out of bounds %d", number);
 147                         return ARMV4_5_MODE_ANY;
 148         }
 149 };
 150
 151 int armv4_5_arch_state(struct target_s *target);
 152 int armv4_5_get_gdb_reg_list(target_t *target,
 153                 reg_t **reg_list[], int *reg_list_size);
 154
 155 int armv4_5_register_commands(struct command_context_s *cmd_ctx);
 156 int armv4_5_init_arch_info(target_t *target, armv4_5_common_t *armv4_5);
 157
 158 int armv4_5_run_algorithm(struct target_s *target,
 159                 int num_mem_params, mem_param_t *mem_params,
 160                 int num_reg_params, reg_param_t *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(target_t *target);
 165
 166 /* ARM mode instructions
 167  */
 168
 169 /* Store multiple increment after
 170  * Rn: base register
 171  * List: for each bit in list: store register
 172  * S: in priviledged mode: store user-mode registers
 173  * W = 1: update the base register. W = 0: leave the base register untouched
 174  */
 175 #define ARMV4_5_STMIA(Rn, List, S, W)   (0xe8800000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
 176
 177 /* Load 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_LDMIA(Rn, List, S, W)   (0xe8900000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
 184
 185 /* MOV r8, r8 */
 186 #define ARMV4_5_NOP                                     (0xe1a08008)
 187
 188 /* Move PSR to general purpose register
 189  * R = 1: SPSR R = 0: CPSR
 190  * Rn: target register
 191  */
 192 #define ARMV4_5_MRS(Rn, R)                      (0xe10f0000 | ((R) << 22) | ((Rn) << 12))
 193
 194 /* Store register
 195  * Rd: register to store
 196  * Rn: base register
 197  */
 198 #define ARMV4_5_STR(Rd, Rn)                     (0xe5800000 | ((Rd) << 12) | ((Rn) << 16))
 199
 200 /* Load register
 201  * Rd: register to load
 202  * Rn: base register
 203  */
 204 #define ARMV4_5_LDR(Rd, Rn)                     (0xe5900000 | ((Rd) << 12) | ((Rn) << 16))
 205
 206 /* Move general purpose register to PSR
 207  * R = 1: SPSR R = 0: CPSR
 208  * Field: Field mask
 209  * 1: control field 2: extension field 4: status field 8: flags field
 210  * Rm: source register
 211  */
 212 #define ARMV4_5_MSR_GP(Rm, Field, R)    (0xe120f000 | (Rm) | ((Field) << 16) | ((R) << 22))
 213 #define ARMV4_5_MSR_IM(Im, Rotate, Field, R)    (0xe320f000 | (Im)  | ((Rotate) << 8) | ((Field) << 16) | ((R) << 22))
 214
 215 /* Load Register Halfword Immediate Post-Index
 216  * Rd: register to load
 217  * Rn: base register
 218  */
 219 #define ARMV4_5_LDRH_IP(Rd, Rn) (0xe0d000b2 | ((Rd) << 12) | ((Rn) << 16))
 220
 221 /* Load Register Byte Immediate Post-Index
 222  * Rd: register to load
 223  * Rn: base register
 224  */
 225 #define ARMV4_5_LDRB_IP(Rd, Rn) (0xe4d00001 | ((Rd) << 12) | ((Rn) << 16))
 226
 227 /* Store register Halfword Immediate Post-Index
 228  * Rd: register to store
 229  * Rn: base register
 230  */
 231 #define ARMV4_5_STRH_IP(Rd, Rn) (0xe0c000b2 | ((Rd) << 12) | ((Rn) << 16))
 232
 233 /* Store register Byte Immediate Post-Index
 234  * Rd: register to store
 235  * Rn: base register
 236  */
 237 #define ARMV4_5_STRB_IP(Rd, Rn) (0xe4c00001 | ((Rd) << 12) | ((Rn) << 16))
 238
 239 /* Branch (and Link)
 240  * Im: Branch target (left-shifted by 2 bits, added to PC)
 241  * L: 1: branch and link 0: branch only
 242  */
 243 #define ARMV4_5_B(Im, L) (0xea000000 | (Im) | ((L) << 24))
 244
 245 /* Branch and exchange (ARM state)
 246  * Rm: register holding branch target address
 247  */
 248 #define ARMV4_5_BX(Rm) (0xe12fff10 | (Rm))
 249
 250 /* Move to ARM register from coprocessor
 251  * CP: Coprocessor number
 252  * op1: Coprocessor opcode
 253  * Rd: destination register
 254  * CRn: first coprocessor operand
 255  * CRm: second coprocessor operand
 256  * op2: Second coprocessor opcode
 257  */
 258 #define ARMV4_5_MRC(CP, op1, Rd, CRn, CRm, op2) (0xee100010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
 259
 260 /* Move to coprocessor from ARM register
 261  * CP: Coprocessor number
 262  * op1: Coprocessor opcode
 263  * Rd: destination register
 264  * CRn: first coprocessor operand
 265  * CRm: second coprocessor operand
 266  * op2: Second coprocessor opcode
 267  */
 268 #define ARMV4_5_MCR(CP, op1, Rd, CRn, CRm, op2) (0xee000010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
 269
 270 /* Breakpoint instruction (ARMv5)
 271  * Im: 16-bit immediate
 272  */
 273 #define ARMV5_BKPT(Im) (0xe1200070 | ((Im & 0xfff0) << 8) | (Im & 0xf))
 274
 275
 276 /* Thumb mode instructions
 277  */
 278
 279 /* Store register (Thumb mode)
 280  * Rd: source register
 281  * Rn: base register
 282  */
 283 #define ARMV4_5_T_STR(Rd, Rn)   ((0x6000 | (Rd) | ((Rn) << 3)) | ((0x6000 | (Rd) | ((Rn) << 3)) << 16))
 284
 285 /* Load register (Thumb state)
 286  * Rd: destination register
 287  * Rn: base register
 288  */
 289 #define ARMV4_5_T_LDR(Rd, Rn)   ((0x6800 | ((Rn) << 3) | (Rd)) | ((0x6800 | ((Rn) << 3) | (Rd)) << 16))
 290
 291 /* Load multiple (Thumb state)
 292  * Rn: base register
 293  * List: for each bit in list: store register
 294  */
 295 #define ARMV4_5_T_LDMIA(Rn, List) ((0xc800 | ((Rn) << 8) | (List)) | ((0xc800 | ((Rn) << 8) | List) << 16))
 296
 297 /* Load register with PC relative addressing
 298  * Rd: register to load
 299  */
 300 #define ARMV4_5_T_LDR_PCREL(Rd) ((0x4800 | ((Rd) << 8)) | ((0x4800 | ((Rd) << 8)) << 16))
 301
 302 /* Move hi register (Thumb mode)
 303  * Rd: destination register
 304  * Rm: source register
 305  */
 306 #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))
 307
 308 /* No operation (Thumb mode)
 309  */
 310 #define ARMV4_5_T_NOP   (0x46c0 | (0x46c0 << 16))
 311
 312 /* Move immediate to register (Thumb state)
 313  * Rd: destination register
 314  * Im: 8-bit immediate value
 315  */
 316 #define ARMV4_5_T_MOV_IM(Rd, Im)        ((0x2000 | ((Rd) << 8) | (Im)) | ((0x2000 | ((Rd) << 8) | (Im)) << 16))
 317
 318 /* Branch and Exchange
 319  * Rm: register containing branch target
 320  */
 321 #define ARMV4_5_T_BX(Rm)                ((0x4700 | ((Rm) << 3)) | ((0x4700 | ((Rm) << 3)) << 16))
 322
 323 /* Branch (Thumb state)
 324  * Imm: Branch target
 325  */
 326 #define ARMV4_5_T_B(Imm)        ((0xe000 | (Imm)) | ((0xe000 | (Imm)) << 16))
 327
 328 /* Breakpoint instruction (ARMv5) (Thumb state)
 329  * Im: 8-bit immediate
 330  */
 331 #define ARMV5_T_BKPT(Im) ((0xbe00 | Im) | ((0xbe00 | Im) << 16))
 332
 333 /* build basic mrc/mcr opcode */
 334
 335 static inline uint32_t mrc_opcode(int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
 336 {
 337         uint32_t t = 0;
 338         t|=op1<<21;
 339         t|=op2<<5;
 340         t|=CRn<<16;
 341         t|=CRm<<0;
 342         return t;
 343 }
 344
 345
 346
 347
 348 #endif /* ARMV4_5_H */