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 "log.h"
  25 #include "arm_adi_v5.h"
  26 #include "armv4_5.h"
  27 #include "armv4_5_mmu.h"
  28 #include "armv4_5_cache.h"
  29
  30 typedef enum armv7a_mode
  31 {
  32         ARMV7A_MODE_USR = 16,
  33         ARMV7A_MODE_FIQ = 17,
  34         ARMV7A_MODE_IRQ = 18,
  35         ARMV7A_MODE_SVC = 19,
  36         ARMV7A_MODE_ABT = 23,
  37         ARMV7A_MODE_UND = 27,
  38         ARMV7A_MODE_SYS = 31,
  39         ARMV7A_MODE_MON = 22,
  40         ARMV7A_MODE_ANY = -1
  41 } armv7a_t;
  42
  43 extern char **armv7a_mode_strings;
  44
  45 typedef enum armv7a_state
  46 {
  47         ARMV7A_STATE_ARM,
  48         ARMV7A_STATE_THUMB,
  49         ARMV7A_STATE_JAZELLE,
  50         ARMV7A_STATE_THUMBEE,
  51 } armv7a_state_t;
  52
  53 extern char *armv7a_state_strings[];
  54
  55 extern int armv7a_core_reg_map[8][17];
  56
  57 #define ARMV7A_CORE_REG_MODE(cache, mode, num) \
  58                 cache->reg_list[armv7a_core_reg_map[armv7a_mode_to_number(mode)][num]]
  59 #define ARMV7A_CORE_REG_MODENUM(cache, mode, num) \
  60                 cache->reg_list[armv7a_core_reg_map[mode][num]]
  61
  62 enum
  63 {
  64         ARM_PC  = 15,
  65         ARM_CPSR = 16
  66 }
  67 ;
  68 /* offsets into armv4_5 core register cache */
  69 enum
  70 {
  71         ARMV7A_CPSR = 31,
  72         ARMV7A_SPSR_FIQ = 32,
  73         ARMV7A_SPSR_IRQ = 33,
  74         ARMV7A_SPSR_SVC = 34,
  75         ARMV7A_SPSR_ABT = 35,
  76         ARMV7A_SPSR_UND = 36
  77 };
  78
  79 #define ARMV4_5_COMMON_MAGIC 0x0A450A45
  80 #define ARMV7_COMMON_MAGIC 0x0A450999
  81
  82 typedef struct armv7a_common_s
  83 {
  84         int common_magic;
  85         reg_cache_t *core_cache;
  86         enum armv7a_mode core_mode;
  87         enum armv7a_state core_state;
  88
  89         /* arm adp debug port */
  90         swjdp_common_t swjdp_info;
  91         armv4_5_mmu_common_t armv4_5_mmu;
  92         armv4_5_common_t armv4_5_common;
  93         void *arch_info;
  94
  95 //      int (*full_context)(struct target_s *target);
  96 //      int (*read_core_reg)(struct target_s *target, int num, enum armv7a_mode mode);
  97 //      int (*write_core_reg)(struct target_s *target, int num, enum armv7a_mode mode, u32 value);
  98         int (*read_cp15)(struct target_s *target,
  99                         uint32_t op1, uint32_t op2,
 100                         uint32_t CRn, uint32_t CRm, uint32_t *value);
 101         int (*write_cp15)(struct target_s *target,
 102                         uint32_t op1, uint32_t op2,
 103                         uint32_t CRn, uint32_t CRm, uint32_t value);
 104
 105         int (*examine_debug_reason)(target_t *target);
 106         void (*pre_debug_entry)(target_t *target);
 107         void (*post_debug_entry)(target_t *target);
 108
 109         void (*pre_restore_context)(target_t *target);
 110         void (*post_restore_context)(target_t *target);
 111
 112 } armv7a_common_t;
 113
 114 typedef struct armv7a_algorithm_s
 115 {
 116         int common_magic;
 117
 118         enum armv7a_mode core_mode;
 119         enum armv7a_state core_state;
 120 } armv7a_algorithm_t;
 121
 122 typedef struct armv7a_core_reg_s
 123 {
 124         int num;
 125         enum armv7a_mode mode;
 126         target_t *target;
 127         armv7a_common_t *armv7a_common;
 128 } armv7a_core_reg_t;
 129
 130 int armv7a_arch_state(struct target_s *target);
 131 reg_cache_t *armv7a_build_reg_cache(target_t *target,
 132                 armv7a_common_t *armv7a_common);
 133 int armv7a_register_commands(struct command_context_s *cmd_ctx);
 134 int armv7a_init_arch_info(target_t *target, armv7a_common_t *armv7a);
 135
 136 /* map psr mode bits to linear number */
 137 static inline int armv7a_mode_to_number(enum armv7a_mode mode)
 138 {
 139         switch (mode)
 140         {
 141                 case ARMV7A_MODE_USR: return 0; break;
 142                 case ARMV7A_MODE_FIQ: return 1; break;
 143                 case ARMV7A_MODE_IRQ: return 2; break;
 144                 case ARMV7A_MODE_SVC: return 3; break;
 145                 case ARMV7A_MODE_ABT: return 4; break;
 146                 case ARMV7A_MODE_UND: return 5; break;
 147                 case ARMV7A_MODE_SYS: return 6; break;
 148                 case ARMV7A_MODE_MON: return 7; break;
 149                 case ARMV7A_MODE_ANY: return 0; break;  /* map MODE_ANY to user mode */
 150                 default:
 151                         LOG_ERROR("invalid mode value encountered, val %d", mode);
 152                         return -1;
 153         }
 154 }
 155
 156 /* map linear number to mode bits */
 157 static inline enum armv7a_mode armv7a_number_to_mode(int number)
 158 {
 159         switch(number)
 160         {
 161                 case 0: return ARMV7A_MODE_USR; break;
 162                 case 1: return ARMV7A_MODE_FIQ; break;
 163                 case 2: return ARMV7A_MODE_IRQ; break;
 164                 case 3: return ARMV7A_MODE_SVC; break;
 165                 case 4: return ARMV7A_MODE_ABT; break;
 166                 case 5: return ARMV7A_MODE_UND; break;
 167                 case 6: return ARMV7A_MODE_SYS; break;
 168                 case 7: return ARMV7A_MODE_MON; break;
 169                 default:
 170                         LOG_ERROR("mode index out of bounds");
 171                         return ARMV7A_MODE_ANY;
 172         }
 173 };
 174
 175
 176 #endif /* ARMV4_5_H */