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  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  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 ARMV7M_COMMON_H
  27 #define ARMV7M_COMMON_H
  28
  29 #include "register.h"
  30 #include "target.h"
  31 #include "arm_jtag.h"
  32 #include "arm_adi_v5.h"
  33
  34 /* define for enabling armv7 gdb workarounds */
  35 #if 1
  36 #define ARMV7_GDB_HACKS
  37 #endif
  38
  39 enum armv7m_mode
  40 {
  41         ARMV7M_MODE_THREAD = 0,
  42         ARMV7M_MODE_USER_THREAD = 1,
  43         ARMV7M_MODE_HANDLER = 2,
  44         ARMV7M_MODE_ANY = -1
  45 };
  46
  47 extern char* armv7m_mode_strings[];
  48
  49 enum armv7m_regtype
  50 {
  51         ARMV7M_REGISTER_CORE_GP,
  52         ARMV7M_REGISTER_CORE_SP,
  53         ARMV7M_REGISTER_MEMMAP
  54 };
  55
  56 extern char* armv7m_exception_strings[];
  57
  58 extern char *armv7m_exception_string(int number);
  59
  60 /* offsets into armv7m core register cache */
  61 enum
  62 {
  63         ARMV7M_PC = 15,
  64         ARMV7M_xPSR = 16,
  65         ARMV7M_MSP,
  66         ARMV7M_PSP,
  67         ARMV7M_PRIMASK,
  68         ARMV7M_BASEPRI,
  69         ARMV7M_FAULTMASK,
  70         ARMV7M_CONTROL,
  71         ARMV7NUMCOREREGS
  72 };
  73
  74 #define ARMV7M_COMMON_MAGIC 0x2A452A45
  75
  76 typedef struct armv7m_common_s
  77 {
  78         int common_magic;
  79         reg_cache_t *core_cache;
  80         enum armv7m_mode core_mode;
  81         int exception_number;
  82         swjdp_common_t swjdp_info;
  83
  84
  85         /* Direct processor core register read and writes */
  86         int (*load_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 *value);
  87         int (*store_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 value);
  88         /* register cache to processor synchronization */
  89         int (*read_core_reg)(struct target_s *target, int num);
  90         int (*write_core_reg)(struct target_s *target, int num);
  91
  92         int (*examine_debug_reason)(target_t *target);
  93         void (*pre_debug_entry)(target_t *target);
  94         void (*post_debug_entry)(target_t *target);
  95
  96         void (*pre_restore_context)(target_t *target);
  97         void (*post_restore_context)(target_t *target);
  98
  99         void *arch_info;
 100 } armv7m_common_t;
 101
 102 typedef struct armv7m_algorithm_s
 103 {
 104         int common_magic;
 105
 106         enum armv7m_mode core_mode;
 107 } armv7m_algorithm_t;
 108
 109 typedef struct armv7m_core_reg_s
 110 {
 111         u32 num;
 112         enum armv7m_regtype type;
 113         enum armv7m_mode mode;
 114         target_t *target;
 115         armv7m_common_t *armv7m_common;
 116 } armv7m_core_reg_t;
 117
 118 extern reg_cache_t *armv7m_build_reg_cache(target_t *target);
 119 extern enum armv7m_mode armv7m_number_to_mode(int number);
 120 extern int armv7m_mode_to_number(enum armv7m_mode mode);
 121
 122 extern int armv7m_arch_state(struct target_s *target);
 123 extern int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_size);
 124 extern int armv7m_invalidate_core_regs(target_t *target);
 125
 126 extern int armv7m_register_commands(struct command_context_s *cmd_ctx);
 127 extern int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m);
 128
 129 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);
 130
 131 extern int armv7m_invalidate_core_regs(target_t *target);
 132
 133 extern int armv7m_restore_context(target_t *target);
 134
 135 extern int armv7m_checksum_memory(struct target_s *target, u32 address, u32 count, u32* checksum);
 136 extern int armv7m_blank_check_memory(struct target_s *target, u32 address, u32 count, u32* blank);
 137
 138 /* Thumb mode instructions
 139  */
 140
 141 /* Move to Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 142  * Rd: destination register
 143  * SYSm: source special register
 144  */
 145 #define ARMV7M_T_MRS(Rd, SYSm)  ((0xF3EF) | ((0x8000 | (Rd<<8) | SYSm) << 16))
 146
 147 /* Move from Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 148  * Rd: source register
 149  * SYSm: destination special register
 150  */
 151 #define ARMV7M_T_MSR(SYSm, Rn)  ((0xF380 | ( Rn<<8 )) | ((0x8800 | SYSm) << 16))
 152
 153 /* Change Processor State. The instruction modifies the PRIMASK and FAULTMASK
 154  * special-purpose register values  (Thumb mode) 16 bit Thumb2 instruction
 155  * Rd: source register
 156  * IF:
 157  */
 158 #define I_FLAG 2
 159 #define F_FLAG 1
 160 #define ARMV7M_T_CPSID(IF)      ((0xB660 | (1<<8) | (IF&0x3)) | ((0xB660 | (1<<8) | (IF&0x3)) << 16))
 161 #define ARMV7M_T_CPSIE(IF)      ((0xB660 | (0<<8) | (IF&0x3)) | ((0xB660 | (0<<8) | (IF&0x3)) << 16))
 162
 163 /* Breakpoint (Thumb mode) v5 onwards
 164  * Im: immediate value used by debugger
 165  */
 166 #define ARMV7M_T_BKPT(Im)       ((0xBE00 | Im ) | ((0xBE00 | Im ) << 16))
 167
 168 /* Store register (Thumb mode)
 169  * Rd: source register
 170  * Rn: base register
 171  */
 172 #define ARMV7M_T_STR(Rd, Rn)    ((0x6000 | Rd | (Rn << 3)) | ((0x6000 | Rd | (Rn << 3)) << 16))
 173
 174 /* Load register (Thumb state)
 175  * Rd: destination register
 176  * Rn: base register
 177  */
 178 #define ARMV7M_T_LDR(Rd, Rn)    ((0x6800 | (Rn << 3) | Rd) | ((0x6800 | (Rn << 3) | Rd) << 16))
 179
 180 /* Load multiple (Thumb state)
 181  * Rn: base register
 182  * List: for each bit in list: store register
 183  */
 184 #define ARMV7M_T_LDMIA(Rn, List) ((0xc800 | (Rn << 8) | List) | ((0xc800 | (Rn << 8) | List) << 16))
 185
 186 /* Load register with PC relative addressing
 187  * Rd: register to load
 188  */
 189 #define ARMV7M_T_LDR_PCREL(Rd)  ((0x4800 | (Rd << 8)) | ((0x4800 | (Rd << 8)) << 16))
 190
 191 /* Move hi register (Thumb mode)
 192  * Rd: destination register
 193  * Rm: source register
 194  */
 195 #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))
 196
 197 /* No operation (Thumb mode)
 198  */
 199 #define ARMV7M_T_NOP    (0x46c0 | (0x46c0 << 16))
 200
 201 /* Move immediate to register (Thumb state)
 202  * Rd: destination register
 203  * Im: 8-bit immediate value
 204  */
 205 #define ARMV7M_T_MOV_IM(Rd, Im) ((0x2000 | (Rd << 8) | Im) | ((0x2000 | (Rd << 8) | Im) << 16))
 206
 207 /* Branch and Exchange
 208  * Rm: register containing branch target
 209  */
 210 #define ARMV7M_T_BX(Rm)         ((0x4700 | (Rm << 3)) | ((0x4700 | (Rm << 3)) << 16))
 211
 212 /* Branch (Thumb state)
 213  * Imm: Branch target
 214  */
 215 #define ARMV7M_T_B(Imm) ((0xe000 | Imm) | ((0xe000 | Imm) << 16))
 216
 217 #endif /* ARMV7M_H */