src/target/armv7a.h

   1 /***************************************************************************
   2  *    Copyright (C) 2009 by David Brownell                                 *
   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 #ifndef ARMV7A_H
  20 #define ARMV7A_H
  21
  22 #include "register.h"
  23 #include "target.h"
  24 #include "arm_adi_v5.h"
  25 #include "armv4_5.h"
  26 #include "armv4_5_mmu.h"
  27 #include "armv4_5_cache.h"
  28
  29 typedef enum armv7a_mode
  30 {
  31         ARMV7A_MODE_USR = 16,
  32         ARMV7A_MODE_FIQ = 17,
  33         ARMV7A_MODE_IRQ = 18,
  34         ARMV7A_MODE_SVC = 19,
  35         ARMV7A_MODE_ABT = 23,
  36         ARMV7A_MODE_UND = 27,
  37         ARMV7A_MODE_SYS = 31,
  38         ARMV7A_MODE_MON = 22,
  39         ARMV7A_MODE_ANY = -1
  40 } armv7a_t;
  41
  42 extern char **armv7a_mode_strings;
  43
  44 typedef enum armv7a_state
  45 {
  46         ARMV7A_STATE_ARM,
  47         ARMV7A_STATE_THUMB,
  48         ARMV7A_STATE_JAZELLE,
  49         ARMV7A_STATE_THUMBEE,
  50 } armv7a_state_t;
  51
  52 extern char *armv7a_state_strings[];
  53
  54 extern int armv7a_core_reg_map[8][17];
  55
  56 #define ARMV7A_CORE_REG_MODE(cache, mode, num) \
  57                 cache->reg_list[armv7a_core_reg_map[armv7a_mode_to_number(mode)][num]]
  58 #define ARMV7A_CORE_REG_MODENUM(cache, mode, num) \
  59                 cache->reg_list[armv7a_core_reg_map[mode][num]]
  60
  61 enum
  62 {
  63         ARM_PC  = 15,
  64         ARM_CPSR = 16
  65 }
  66 ;
  67 /* offsets into armv4_5 core register cache */
  68 enum
  69 {
  70         ARMV7A_CPSR = 31,
  71         ARMV7A_SPSR_FIQ = 32,
  72         ARMV7A_SPSR_IRQ = 33,
  73         ARMV7A_SPSR_SVC = 34,
  74         ARMV7A_SPSR_ABT = 35,
  75         ARMV7A_SPSR_UND = 36
  76 };
  77
  78 #define ARMV4_5_COMMON_MAGIC 0x0A450A45
  79 #define ARMV7_COMMON_MAGIC 0x0A450999
  80
  81 /* VA to PA translation operations opc2 values*/
  82 #define V2PCWPR  0
  83 #define V2PCWPW  1
  84 #define V2PCWUR  2
  85 #define V2PCWUW  3
  86 #define V2POWPR  4
  87 #define V2POWPW  5
  88 #define V2POWUR  6
  89 #define V2POWUW  7
  90
  91 struct armv7a_common
  92 {
  93         int common_magic;
  94         struct reg_cache *core_cache;
  95         enum armv7a_mode core_mode;
  96         enum armv7a_state core_state;
  97
  98         /* arm adp debug port */
  99         struct swjdp_common swjdp_info;
 100
 101         /* Core Debug Unit */
 102         uint32_t debug_base;
 103         uint8_t debug_ap;
 104         uint8_t memory_ap;
 105
 106         /* Cache and Memory Management Unit */
 107         struct armv4_5_mmu_common armv4_5_mmu;
 108         struct arm armv4_5_common;
 109
 110 //      int (*full_context)(struct target *target);
 111 //      int (*read_core_reg)(struct target *target, int num, enum armv7a_mode mode);
 112 //      int (*write_core_reg)(struct target *target, int num, enum armv7a_mode mode, u32 value);
 113         int (*read_cp15)(struct target *target,
 114                         uint32_t op1, uint32_t op2,
 115                         uint32_t CRn, uint32_t CRm, uint32_t *value);
 116         int (*write_cp15)(struct target *target,
 117                         uint32_t op1, uint32_t op2,
 118                         uint32_t CRn, uint32_t CRm, uint32_t value);
 119
 120         int (*examine_debug_reason)(struct target *target);
 121         void (*post_debug_entry)(struct target *target);
 122
 123         void (*pre_restore_context)(struct target *target);
 124         void (*post_restore_context)(struct target *target);
 125
 126 };
 127
 128 static inline struct armv7a_common *
 129 target_to_armv7a(struct target *target)
 130 {
 131         return container_of(target->arch_info, struct armv7a_common,
 132                         armv4_5_common);
 133 }
 134
 135 struct armv7a_algorithm
 136 {
 137         int common_magic;
 138
 139         enum armv7a_mode core_mode;
 140         enum armv7a_state core_state;
 141 };
 142
 143 struct armv7a_core_reg
 144 {
 145         int num;
 146         enum armv7a_mode mode;
 147         struct target *target;
 148         struct armv7a_common *armv7a_common;
 149 };
 150
 151 int armv7a_arch_state(struct target *target);
 152 struct reg_cache *armv7a_build_reg_cache(struct target *target,
 153                 struct armv7a_common *armv7a_common);
 154 int armv7a_register_commands(struct command_context *cmd_ctx);
 155 int armv7a_init_arch_info(struct target *target, struct armv7a_common *armv7a);
 156
 157 /* map psr mode bits to linear number */
 158 static inline int armv7a_mode_to_number(enum armv7a_mode mode)
 159 {
 160         switch (mode)
 161         {
 162                 case ARMV7A_MODE_USR: return 0; break;
 163                 case ARMV7A_MODE_FIQ: return 1; break;
 164                 case ARMV7A_MODE_IRQ: return 2; break;
 165                 case ARMV7A_MODE_SVC: return 3; break;
 166                 case ARMV7A_MODE_ABT: return 4; break;
 167                 case ARMV7A_MODE_UND: return 5; break;
 168                 case ARMV7A_MODE_SYS: return 6; break;
 169                 case ARMV7A_MODE_MON: return 7; break;
 170                 case ARMV7A_MODE_ANY: return 0; break;  /* map MODE_ANY to user mode */
 171                 default:
 172                         LOG_ERROR("invalid mode value encountered, val %d", mode);
 173                         return -1;
 174         }
 175 }
 176
 177 /* map linear number to mode bits */
 178 static inline enum armv7a_mode armv7a_number_to_mode(int number)
 179 {
 180         switch(number)
 181         {
 182                 case 0: return ARMV7A_MODE_USR; break;
 183                 case 1: return ARMV7A_MODE_FIQ; break;
 184                 case 2: return ARMV7A_MODE_IRQ; break;
 185                 case 3: return ARMV7A_MODE_SVC; break;
 186                 case 4: return ARMV7A_MODE_ABT; break;
 187                 case 5: return ARMV7A_MODE_UND; break;
 188                 case 6: return ARMV7A_MODE_SYS; break;
 189                 case 7: return ARMV7A_MODE_MON; break;
 190                 default:
 191                         LOG_ERROR("mode index out of bounds");
 192                         return ARMV7A_MODE_ANY;
 193         }
 194 };
 195
 196
 197 #endif /* ARMV4_5_H */