src/target/armv7m.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2006 by Magnus Lundin                                   *
   6  *   lundin@mlu.mine.nu                                                    *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23 #ifndef ARMV7M_COMMON_H
  24 #define ARMV7M_COMMON_H
  25
  26 #include "register.h"
  27 #include "target.h"
  28 #include "arm_jtag.h"
  29
  30 enum armv7m_mode
  31 {
  32         ARMV7M_MODE_HANDLER = 0,
  33         ARMV7M_MODE_THREAD = 1,
  34         ARMV7M_MODE_ANY = -1
  35 };
  36
  37 extern char* armv7m_mode_strings[];
  38
  39 enum armv7m_state
  40 {
  41         ARMV7M_STATE_THUMB,
  42         ARMV7M_STATE_DEBUG,
  43 };
  44
  45 enum armv7m_regtype
  46 {
  47         ARMV7M_REGISTER_CORE_GP,
  48         ARMV7M_REGISTER_CORE_SP,
  49         ARMV7M_REGISTER_MEMMAP
  50 };
  51
  52 enum armv7m_runcontext
  53 {
  54         ARMV7M_PROCESS_CONTEXT,
  55         ARMV7M_DEBUG_CONTEXT
  56 };
  57
  58 extern char* armv7m_state_strings[];
  59 extern char* armv7m_exception_strings[];
  60
  61 extern char *armv7m_exception_string(int number);
  62
  63 /* offsets into armv7m core register cache */
  64 enum
  65 {
  66         ARMV7M_PC = 15,
  67         ARMV7M_xPSR = 16,
  68         ARMV7M_MSP,
  69         ARMV7M_PSP,
  70         ARMV7M_PRIMASK,
  71         ARMV7M_BASEPRI,
  72         ARMV7M_FAULTMASK,
  73         ARMV7M_CONTROL,
  74         ARMV7NUMCOREREGS
  75 };
  76
  77 #define ARMV7M_COMMON_MAGIC 0x2A452A45
  78
  79 typedef struct armv7m_common_s
  80 {
  81         int common_magic;
  82         reg_cache_t *core_cache;
  83         reg_cache_t *process_context;
  84         reg_cache_t *debug_context;
  85         enum armv7m_mode core_mode;
  86         enum armv7m_state core_state;
  87         int  exception_number;
  88
  89         /* Direct processor core register read and writes */
  90         int (*load_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 *value);
  91         int (*store_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 value);
  92         /* register cache to processor synchronization */
  93         int (*read_core_reg)(struct target_s *target, int num);
  94         int (*write_core_reg)(struct target_s *target, int num);
  95
  96         arm_jtag_t jtag_info;
  97
  98         int (*examine_debug_reason)(target_t *target);
  99         void (*pre_debug_entry)(target_t *target);
 100         void (*post_debug_entry)(target_t *target);
 101
 102         void (*pre_restore_context)(target_t *target);
 103         void (*post_restore_context)(target_t *target);
 104
 105         void *arch_info;
 106 } armv7m_common_t;
 107
 108 typedef struct armv7m_algorithm_s
 109 {
 110         int common_magic;
 111
 112         enum armv7m_mode core_mode;
 113         enum armv7m_state core_state;
 114 } armv7m_algorithm_t;
 115
 116 typedef struct armv7m_core_reg_s
 117 {
 118         u32 num;
 119         enum armv7m_regtype type;
 120         enum armv7m_mode mode;
 121         target_t *target;
 122         armv7m_common_t *armv7m_common;
 123 } armv7m_core_reg_t;
 124
 125 extern reg_cache_t *armv7m_build_reg_cache(target_t *target);
 126 extern enum armv7m_mode armv7m_number_to_mode(int number);
 127 extern int armv7m_mode_to_number(enum armv7m_mode mode);
 128
 129 extern int armv7m_arch_state(struct target_s *target);
 130 extern int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_size);
 131 extern int armv7m_invalidate_core_regs(target_t *target);
 132
 133 extern int armv7m_register_commands(struct command_context_s *cmd_ctx);
 134 extern int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m);
 135
 136 extern int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_params, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
 137
 138 extern int armv7m_invalidate_core_regs(target_t *target);
 139
 140 extern enum armv7m_runcontext armv7m_get_context(target_t *target);
 141 extern int armv7m_use_context(target_t *target, enum armv7m_runcontext new_ctx);
 142 extern enum armv7m_runcontext armv7m_get_context(target_t *target);
 143 extern int armv7m_restore_context(target_t *target);
 144
 145 extern int armv7m_checksum_memory(struct target_s *target, u32 address, u32 count, u32* checksum);
 146
 147 /* Thumb mode instructions
 148  */
 149
 150 /* Move to Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 151  * Rd: destination register
 152  * SYSm: source special register
 153  */
 154 #define ARMV7M_T_MRS(Rd, SYSm)  ((0xF3EF) | ((0x8000 | (Rd<<8) | SYSm) << 16))
 155
 156 /* Move from Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 157  * Rd: source register
 158  * SYSm: destination special register
 159  */
 160 #define ARMV7M_T_MSR(SYSm, Rn)  ((0xF380 | ( Rn<<8 )) | ((0x8800 | SYSm) << 16))
 161
 162 /* Change Processor State. The instruction modifies the PRIMASK and FAULTMASK
 163  * special-purpose register values  (Thumb mode) 16 bit Thumb2 instruction
 164  * Rd: source register
 165  * IF:
 166  */
 167 #define I_FLAG 2
 168 #define F_FLAG 1
 169 #define ARMV7M_T_CPSID(IF)      ((0xB660 | (1<<8) | (IF&0x3)) | ((0xB660 | (1<<8) | (IF&0x3)) << 16))
 170 #define ARMV7M_T_CPSIE(IF)      ((0xB660 | (0<<8) | (IF&0x3)) | ((0xB660 | (0<<8) | (IF&0x3)) << 16))
 171
 172 /* Breakpoint (Thumb mode) v5 onwards
 173  * Im: immediate value used by debugger
 174  */
 175 #define ARMV7M_T_BKPT(Im)       ((0xBE00 | Im ) | ((0xBE00 | Im ) << 16))
 176
 177 /* Store register (Thumb mode)
 178  * Rd: source register
 179  * Rn: base register
 180  */
 181 #define ARMV7M_T_STR(Rd, Rn)    ((0x6000 | Rd | (Rn << 3)) | ((0x6000 | Rd | (Rn << 3)) << 16))
 182
 183 /* Load register (Thumb state)
 184  * Rd: destination register
 185  * Rn: base register
 186  */
 187 #define ARMV7M_T_LDR(Rd, Rn)    ((0x6800 | (Rn << 3) | Rd) | ((0x6800 | (Rn << 3) | Rd) << 16))
 188
 189 /* Load multiple (Thumb state)
 190  * Rn: base register
 191  * List: for each bit in list: store register
 192  */
 193 #define ARMV7M_T_LDMIA(Rn, List) ((0xc800 | (Rn << 8) | List) | ((0xc800 | (Rn << 8) | List) << 16))
 194
 195 /* Load register with PC relative addressing
 196  * Rd: register to load
 197  */
 198 #define ARMV7M_T_LDR_PCREL(Rd)  ((0x4800 | (Rd << 8)) | ((0x4800 | (Rd << 8)) << 16))
 199
 200 /* Move hi register (Thumb mode)
 201  * Rd: destination register
 202  * Rm: source register
 203  */
 204 #define ARMV7M_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))
 205
 206 /* No operation (Thumb mode)
 207  */
 208 #define ARMV7M_T_NOP    (0x46c0 | (0x46c0 << 16))
 209
 210 /* Move immediate to register (Thumb state)
 211  * Rd: destination register
 212  * Im: 8-bit immediate value
 213  */
 214 #define ARMV7M_T_MOV_IM(Rd, Im) ((0x2000 | (Rd << 8) | Im) | ((0x2000 | (Rd << 8) | Im) << 16))
 215
 216 /* Branch and Exchange
 217  * Rm: register containing branch target
 218  */
 219 #define ARMV7M_T_BX(Rm)         ((0x4700 | (Rm << 3)) | ((0x4700 | (Rm << 3)) << 16))
 220
 221 /* Branch (Thumb state)
 222  * Imm: Branch target
 223  */
 224 #define ARMV7M_T_B(Imm) ((0xe000 | Imm) | ((0xe000 | Imm) << 16))
 225
 226 #endif /* ARMV7M_H */