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
  27 #ifndef ARMV7M_COMMON_H
  28 #define ARMV7M_COMMON_H
  29
  30 #include "arm_adi_v5.h"
  31 #include "arm.h"
  32
  33 /* define for enabling armv7 gdb workarounds */
  34 #if 1
  35 #define ARMV7_GDB_HACKS
  36 #endif
  37
  38 #ifdef ARMV7_GDB_HACKS
  39 extern uint8_t armv7m_gdb_dummy_cpsr_value[];
  40 extern struct reg armv7m_gdb_dummy_cpsr_reg;
  41 #endif
  42
  43 enum armv7m_mode {
  44         ARMV7M_MODE_THREAD = 0,
  45         ARMV7M_MODE_USER_THREAD = 1,
  46         ARMV7M_MODE_HANDLER = 2,
  47         ARMV7M_MODE_ANY = -1
  48 };
  49
  50 extern char *armv7m_mode_strings[];
  51 extern const int armv7m_psp_reg_map[];
  52 extern const int armv7m_msp_reg_map[];
  53
  54 enum armv7m_regtype {
  55         ARMV7M_REGISTER_CORE_GP,
  56         ARMV7M_REGISTER_CORE_SP,
  57         ARMV7M_REGISTER_MEMMAP
  58 };
  59
  60 char *armv7m_exception_string(int number);
  61
  62 /* offsets into armv7m core register cache */
  63 enum {
  64         /* for convenience, the first set of indices match
  65          * the Cortex-M3/-M4 DCRSR selectors
  66          */
  67         ARMV7M_R0,
  68         ARMV7M_R1,
  69         ARMV7M_R2,
  70         ARMV7M_R3,
  71
  72         ARMV7M_R4,
  73         ARMV7M_R5,
  74         ARMV7M_R6,
  75         ARMV7M_R7,
  76
  77         ARMV7M_R8,
  78         ARMV7M_R9,
  79         ARMV7M_R10,
  80         ARMV7M_R11,
  81
  82         ARMV7M_R12,
  83         ARMV7M_R13,
  84         ARMV7M_R14,
  85         ARMV7M_PC = 15,
  86
  87         ARMV7M_xPSR = 16,
  88         ARMV7M_MSP,
  89         ARMV7M_PSP,
  90
  91         /* this next set of indices is arbitrary */
  92         ARMV7M_PRIMASK,
  93         ARMV7M_BASEPRI,
  94         ARMV7M_FAULTMASK,
  95         ARMV7M_CONTROL,
  96
  97         /* 32bit Floating-point registers */
  98         ARMV7M_S0,
  99         ARMV7M_S1,
 100         ARMV7M_S2,
 101         ARMV7M_S3,
 102         ARMV7M_S4,
 103         ARMV7M_S5,
 104         ARMV7M_S6,
 105         ARMV7M_S7,
 106         ARMV7M_S8,
 107         ARMV7M_S9,
 108         ARMV7M_S10,
 109         ARMV7M_S11,
 110         ARMV7M_S12,
 111         ARMV7M_S13,
 112         ARMV7M_S14,
 113         ARMV7M_S15,
 114         ARMV7M_S16,
 115         ARMV7M_S17,
 116         ARMV7M_S18,
 117         ARMV7M_S19,
 118         ARMV7M_S20,
 119         ARMV7M_S21,
 120         ARMV7M_S22,
 121         ARMV7M_S23,
 122         ARMV7M_S24,
 123         ARMV7M_S25,
 124         ARMV7M_S26,
 125         ARMV7M_S27,
 126         ARMV7M_S28,
 127         ARMV7M_S29,
 128         ARMV7M_S30,
 129         ARMV7M_S31,
 130
 131         /* 64bit Floating-point registers */
 132         ARMV7M_D0,
 133         ARMV7M_D1,
 134         ARMV7M_D2,
 135         ARMV7M_D3,
 136         ARMV7M_D4,
 137         ARMV7M_D5,
 138         ARMV7M_D6,
 139         ARMV7M_D7,
 140         ARMV7M_D8,
 141         ARMV7M_D9,
 142         ARMV7M_D10,
 143         ARMV7M_D11,
 144         ARMV7M_D12,
 145         ARMV7M_D13,
 146         ARMV7M_D14,
 147         ARMV7M_D15,
 148
 149         /* Floating-point status registers */
 150         ARMV7M_FPSID,
 151         ARMV7M_FPSCR,
 152         ARMV7M_FPEXC,
 153
 154         ARMV7M_LAST_REG,
 155 };
 156
 157 enum {
 158         FP_NONE = 0,
 159         FPv4_SP,
 160 };
 161
 162 #define ARMV7M_COMMON_MAGIC 0x2A452A45
 163
 164 struct armv7m_common {
 165         struct arm      arm;
 166
 167         int common_magic;
 168         struct reg_cache *core_cache;
 169         enum armv7m_mode core_mode;
 170         int exception_number;
 171         struct adiv5_dap dap;
 172
 173         int fp_feature;
 174         uint32_t demcr;
 175
 176         /* stlink is a high level adapter, does not support all functions */
 177         bool stlink;
 178
 179         /* Direct processor core register read and writes */
 180         int (*load_core_reg_u32)(struct target *target,
 181                 enum armv7m_regtype type, uint32_t num, uint32_t *value);
 182         int (*store_core_reg_u32)(struct target *target,
 183                 enum armv7m_regtype type, uint32_t num, uint32_t value);
 184
 185         /* register cache to processor synchronization */
 186         int (*read_core_reg)(struct target *target, unsigned num);
 187         int (*write_core_reg)(struct target *target, unsigned num);
 188
 189         int (*examine_debug_reason)(struct target *target);
 190         int (*post_debug_entry)(struct target *target);
 191
 192         void (*pre_restore_context)(struct target *target);
 193 };
 194
 195 static inline struct armv7m_common *
 196 target_to_armv7m(struct target *target)
 197 {
 198         return container_of(target->arch_info, struct armv7m_common, arm);
 199 }
 200
 201 static inline bool is_armv7m(struct armv7m_common *armv7m)
 202 {
 203         return armv7m->common_magic == ARMV7M_COMMON_MAGIC;
 204 }
 205
 206 struct armv7m_algorithm {
 207         int common_magic;
 208
 209         enum armv7m_mode core_mode;
 210
 211         uint32_t context[ARMV7M_LAST_REG]; /* ARMV7M_NUM_REGS */
 212 };
 213
 214 struct armv7m_core_reg {
 215         uint32_t num;
 216         enum armv7m_regtype type;
 217         struct target *target;
 218         struct armv7m_common *armv7m_common;
 219 };
 220
 221 struct reg_cache *armv7m_build_reg_cache(struct target *target);
 222 enum armv7m_mode armv7m_number_to_mode(int number);
 223 int armv7m_mode_to_number(enum armv7m_mode mode);
 224
 225 int armv7m_arch_state(struct target *target);
 226 int armv7m_get_gdb_reg_list(struct target *target,
 227                 struct reg **reg_list[], int *reg_list_size);
 228
 229 int armv7m_init_arch_info(struct target *target, struct armv7m_common *armv7m);
 230
 231 int armv7m_run_algorithm(struct target *target,
 232                 int num_mem_params, struct mem_param *mem_params,
 233                 int num_reg_params, struct reg_param *reg_params,
 234                 uint32_t entry_point, uint32_t exit_point,
 235                 int timeout_ms, void *arch_info);
 236
 237 int armv7m_start_algorithm(struct target *target,
 238                 int num_mem_params, struct mem_param *mem_params,
 239                 int num_reg_params, struct reg_param *reg_params,
 240                 uint32_t entry_point, uint32_t exit_point,
 241                 void *arch_info);
 242
 243 int armv7m_wait_algorithm(struct target *target,
 244                 int num_mem_params, struct mem_param *mem_params,
 245                 int num_reg_params, struct reg_param *reg_params,
 246                 uint32_t exit_point, int timeout_ms,
 247                 void *arch_info);
 248
 249 int armv7m_invalidate_core_regs(struct target *target);
 250
 251 int armv7m_restore_context(struct target *target);
 252
 253 int armv7m_checksum_memory(struct target *target,
 254                 uint32_t address, uint32_t count, uint32_t *checksum);
 255 int armv7m_blank_check_memory(struct target *target,
 256                 uint32_t address, uint32_t count, uint32_t *blank);
 257
 258 int armv7m_maybe_skip_bkpt_inst(struct target *target, bool *inst_found);
 259
 260 extern const struct command_registration armv7m_command_handlers[];
 261
 262 #endif /* ARMV7M_H */