]> git.sur5r.net Git - openocd/blobdiff - src/target/armv7m.h
armv7m: use generic register core_cache
[openocd] / src / target / armv7m.h
index 49043e1d3b6b87fef892379a38a07588b72be550..20ad7c122d8fef223801488d4ae56f18a8fc0290 100644 (file)
@@ -1,9 +1,13 @@
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
+ *                                                                         *
  *   Copyright (C) 2006 by Magnus Lundin                                   *
  *   lundin@mlu.mine.nu                                                    *
  *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef ARMV7M_COMMON_H
 #define ARMV7M_COMMON_H
 
-#include "register.h"
-#include "target.h"
-#include "arm_jtag.h"
-
-enum armv7m_mode
-{
-       ARMV7M_MODE_HANDLER = 0, 
-       ARMV7M_MODE_THREAD = 1, 
-       ARMV7M_MODE_ANY = -1
-};
-
-extern char* armv7m_mode_strings[];
-
-enum armv7m_state
-{
-       ARMV7M_STATE_THUMB,
-       ARMV7M_STATE_DEBUG,
-};
+#include "arm_adi_v5.h"
+#include "arm.h"
 
-enum armv7m_regtype
-{
-       ARMV7M_REGISTER_CORE_GP,
-       ARMV7M_REGISTER_CORE_SP,
-       ARMV7M_REGISTER_MEMMAP
-};
+/* define for enabling armv7 gdb workarounds */
+#if 1
+#define ARMV7_GDB_HACKS
+#endif
 
-enum armv7m_runcontext
-{
-       ARMV7M_PROCESS_CONTEXT,
-       ARMV7M_DEBUG_CONTEXT
-};
+#ifdef ARMV7_GDB_HACKS
+extern uint8_t armv7m_gdb_dummy_cpsr_value[];
+extern struct reg armv7m_gdb_dummy_cpsr_reg;
+#endif
 
-extern char* armv7m_state_strings[];
-extern char* armv7m_exception_strings[];
+extern const int armv7m_psp_reg_map[];
+extern const int armv7m_msp_reg_map[];
 
-extern char *armv7m_exception_string(int number);
+char *armv7m_exception_string(int number);
 
 /* offsets into armv7m core register cache */
-enum 
-{
+enum {
+       /* for convenience, the first set of indices match
+        * the Cortex-M3/-M4 DCRSR selectors
+        */
+       ARMV7M_R0,
+       ARMV7M_R1,
+       ARMV7M_R2,
+       ARMV7M_R3,
+
+       ARMV7M_R4,
+       ARMV7M_R5,
+       ARMV7M_R6,
+       ARMV7M_R7,
+
+       ARMV7M_R8,
+       ARMV7M_R9,
+       ARMV7M_R10,
+       ARMV7M_R11,
+
+       ARMV7M_R12,
+       ARMV7M_R13,
+       ARMV7M_R14,
        ARMV7M_PC = 15,
+
        ARMV7M_xPSR = 16,
        ARMV7M_MSP,
        ARMV7M_PSP,
+
+       /* this next set of indices is arbitrary */
        ARMV7M_PRIMASK,
        ARMV7M_BASEPRI,
        ARMV7M_FAULTMASK,
        ARMV7M_CONTROL,
-       ARMV7NUMCOREREGS
+
+       /* 32bit Floating-point registers */
+       ARMV7M_S0,
+       ARMV7M_S1,
+       ARMV7M_S2,
+       ARMV7M_S3,
+       ARMV7M_S4,
+       ARMV7M_S5,
+       ARMV7M_S6,
+       ARMV7M_S7,
+       ARMV7M_S8,
+       ARMV7M_S9,
+       ARMV7M_S10,
+       ARMV7M_S11,
+       ARMV7M_S12,
+       ARMV7M_S13,
+       ARMV7M_S14,
+       ARMV7M_S15,
+       ARMV7M_S16,
+       ARMV7M_S17,
+       ARMV7M_S18,
+       ARMV7M_S19,
+       ARMV7M_S20,
+       ARMV7M_S21,
+       ARMV7M_S22,
+       ARMV7M_S23,
+       ARMV7M_S24,
+       ARMV7M_S25,
+       ARMV7M_S26,
+       ARMV7M_S27,
+       ARMV7M_S28,
+       ARMV7M_S29,
+       ARMV7M_S30,
+       ARMV7M_S31,
+
+       /* 64bit Floating-point registers */
+       ARMV7M_D0,
+       ARMV7M_D1,
+       ARMV7M_D2,
+       ARMV7M_D3,
+       ARMV7M_D4,
+       ARMV7M_D5,
+       ARMV7M_D6,
+       ARMV7M_D7,
+       ARMV7M_D8,
+       ARMV7M_D9,
+       ARMV7M_D10,
+       ARMV7M_D11,
+       ARMV7M_D12,
+       ARMV7M_D13,
+       ARMV7M_D14,
+       ARMV7M_D15,
+
+       /* Floating-point status registers */
+       ARMV7M_FPSID,
+       ARMV7M_FPSCR,
+       ARMV7M_FPEXC,
+
+       ARMV7M_LAST_REG,
+};
+
+enum {
+       FP_NONE = 0,
+       FPv4_SP,
 };
 
 #define ARMV7M_COMMON_MAGIC 0x2A452A45
 
-typedef struct armv7m_common_s
-{
+struct armv7m_common {
+       struct arm      arm;
+
        int common_magic;
-       reg_cache_t *core_cache;
-       reg_cache_t *process_context;
-       reg_cache_t *debug_context;
-       enum armv7m_mode core_mode;
-       enum armv7m_state core_state;
-       int  exception_number;
-       int (*full_context)(struct target_s *target);
+       int exception_number;
+       struct adiv5_dap dap;
+
+       int fp_feature;
+       uint32_t demcr;
+
+       /* stlink is a high level adapter, does not support all functions */
+       bool stlink;
+
        /* Direct processor core register read and writes */
-       int (*load_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 *value);
-       int (*store_core_reg_u32)(struct target_s *target, enum armv7m_regtype type, u32 num, u32 value);
+       int (*load_core_reg_u32)(struct target *target, uint32_t num, uint32_t *value);
+       int (*store_core_reg_u32)(struct target *target, uint32_t num, uint32_t value);
+
        /* register cache to processor synchronization */
-       int (*read_core_reg)(struct target_s *target, int num);
-       int (*write_core_reg)(struct target_s *target, int num);
-       /* get or set register through cache, return error if target is running and synchronisation is impossible */
-       int (*get_core_reg_32)(struct target_s *target, int num, u32* value);
-       int (*set_core_reg_32)(struct target_s *target, int num, u32 value);
-
-       arm_jtag_t jtag_info;
-       reg_cache_t *eice_cache;
-       reg_cache_t *etm_cache;
-
-       int (*examine_debug_reason)(target_t *target);
-       
-       void (*change_to_arm)(target_t *target, u32 *r0, u32 *pc);
-       
-//     void (*read_core_regs)(target_t *target, u32 mask, u32 *core_regs[16]);
-//     void (*read_core_regs_target_buffer)(target_t *target, u32 mask, void *buffer, int size);
-//     void (*write_core_regs)(target_t *target, u32 mask, u32 core_regs[16]);
-
-/*
-       void (*write_xpsr_im8)(target_t *target, u8 xpsr_im, int rot, int spsr);
-       
-       void (*load_word_regs)(target_t *target, u32 mask);
-       void (*load_hword_reg)(target_t *target, int num);
-       void (*load_byte_reg)(target_t *target, int num);
-
-       void (*store_word_regs)(target_t *target, u32 mask);
-       void (*store_hword_reg)(target_t *target, int num);
-       void (*store_byte_reg)(target_t *target, int num);
-       
-       void (*write_pc)(target_t *target, u32 pc);
-       void (*branch_resume)(target_t *target);
-*/     
-
-       void (*pre_debug_entry)(target_t *target);
-       void (*post_debug_entry)(target_t *target);
-       
-       void (*pre_restore_context)(target_t *target);
-       void (*post_restore_context)(target_t *target);
-
-       void *arch_info;
-} armv7m_common_t;
-
-typedef struct armv7m_algorithm_s
+       int (*read_core_reg)(struct target *target, unsigned num);
+       int (*write_core_reg)(struct target *target, unsigned num);
+
+       int (*examine_debug_reason)(struct target *target);
+       int (*post_debug_entry)(struct target *target);
+
+       void (*pre_restore_context)(struct target *target);
+};
+
+static inline struct armv7m_common *
+target_to_armv7m(struct target *target)
 {
-       int common_magic;
-               
-       enum armv7m_mode core_mode;
-       enum armv7m_state core_state;
-} armv7m_algorithm_t;
+       return container_of(target->arch_info, struct armv7m_common, arm);
+}
 
-typedef struct armv7m_core_reg_s
+static inline bool is_armv7m(struct armv7m_common *armv7m)
 {
-       u32 num;
-       enum armv7m_regtype type;
-       enum armv7m_mode mode;
-       target_t *target;
-       armv7m_common_t *armv7m_common;
-} armv7m_core_reg_t;
-
-extern reg_cache_t *armv7m_build_reg_cache(target_t *target);
-extern enum armv7m_mode armv7m_number_to_mode(int number);
-extern int armv7m_mode_to_number(enum armv7m_mode mode);
-
-extern int armv7m_arch_state(struct target_s *target, char *buf, int buf_size);
-extern int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_size);
-extern int armv7m_invalidate_core_regs(target_t *target);
-
-extern int armv7m_register_commands(struct command_context_s *cmd_ctx);
-extern int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m);
-
-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);
-
-extern int armv7m_invalidate_core_regs(target_t *target);
-
-extern enum armv7m_runcontext armv7m_get_context(target_t *target);
-extern int armv7m_use_context(target_t *target, enum armv7m_runcontext new_ctx);
-extern enum armv7m_runcontext armv7m_get_context(target_t *target);
-
-/* Thumb mode instructions
- */
-/* Move to Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
- * Rd: destination register
- * SYSm: source special register
- */
-#define ARMV7M_T_MRS(Rd, SYSm) ((0xF3EF) | ((0x8000 | (Rd<<8) | SYSm) << 16)) 
-
-/* Move from Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
- * Rd: source register
- * SYSm: destination special register
- */
-#define ARMV7M_T_MSR(SYSm, Rn) ((0xF380 | ( Rn<<8 )) | ((0x8800 | SYSm) << 16)) 
-
-/* Change Processor State. The instruction modifies the PRIMASK and FAULTMASK 
- * special-purpose register values  (Thumb mode) 16 bit Thumb2 instruction
- * Rd: source register
- * IF: 
- */
-#define I_FLAG 2
-#define F_FLAG 1  
-#define ARMV7M_T_CPSID(IF)     ((0xB660 | (1<<8) | (IF&0x3)) | ((0xB660 | (1<<8) | (IF&0x3)) << 16)) 
-#define ARMV7M_T_CPSIE(IF)     ((0xB660 | (0<<8) | (IF&0x3)) | ((0xB660 | (0<<8) | (IF&0x3)) << 16)) 
-
-/* Breakpoint (Thumb mode) v5 onwards
- * Im: immediate value used by debugger
- */
-#define ARMV7M_T_BKPT(Im)      ((0xBE00 | Im ) | ((0xBE00 | Im ) << 16))
-
-/* Store register (Thumb mode)
- * Rd: source register
- * Rn: base register
- */
-#define ARMV7M_T_STR(Rd, Rn)   ((0x6000 | Rd | (Rn << 3)) | ((0x6000 | Rd | (Rn << 3)) << 16))
-
-/* Load register (Thumb state)
- * Rd: destination register
- * Rn: base register
- */
-#define ARMV7M_T_LDR(Rd, Rn)   ((0x6800 | (Rn << 3) | Rd) | ((0x6800 | (Rn << 3) | Rd) << 16))
-
-/* Load multiple (Thumb state)
- * Rn: base register
- * List: for each bit in list: store register
- */
-#define ARMV7M_T_LDMIA(Rn, List) ((0xc800 | (Rn << 8) | List) | ((0xc800 | (Rn << 8) | List) << 16))
-/* Load register with PC relative addressing
- * Rd: register to load
- */
-#define ARMV7M_T_LDR_PCREL(Rd) ((0x4800 | (Rd << 8)) | ((0x4800 | (Rd << 8)) << 16)) 
-/* Move hi register (Thumb mode)
- * Rd: destination register
- * Rm: source register
- */
-#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))
-
-/* No operation (Thumb mode)
- */
-#define ARMV7M_T_NOP   (0x46c0 | (0x46c0 << 16))
-
-/* Move immediate to register (Thumb state)
- * Rd: destination register
- * Im: 8-bit immediate value
- */
-#define ARMV7M_T_MOV_IM(Rd, Im)        ((0x2000 | (Rd << 8) | Im) | ((0x2000 | (Rd << 8) | Im) << 16))
-
-/* Branch and Exchange
- * Rm: register containing branch target
- */
-#define ARMV7M_T_BX(Rm)                ((0x4700 | (Rm << 3)) | ((0x4700 | (Rm << 3)) << 16))
-
-/* Branch (Thumb state)
- * Imm: Branch target
- */
-#define ARMV7M_T_B(Imm)        ((0xe000 | Imm) | ((0xe000 | Imm) << 16))
+       return armv7m->common_magic == ARMV7M_COMMON_MAGIC;
+}
+
+struct armv7m_algorithm {
+       int common_magic;
+
+       enum arm_mode core_mode;
+
+       uint32_t context[ARMV7M_LAST_REG]; /* ARMV7M_NUM_REGS */
+};
+
+struct reg_cache *armv7m_build_reg_cache(struct target *target);
+enum armv7m_mode armv7m_number_to_mode(int number);
+int armv7m_mode_to_number(enum armv7m_mode mode);
+
+int armv7m_arch_state(struct target *target);
+int armv7m_get_gdb_reg_list(struct target *target,
+               struct reg **reg_list[], int *reg_list_size);
+
+int armv7m_init_arch_info(struct target *target, struct armv7m_common *armv7m);
+
+int armv7m_run_algorithm(struct target *target,
+               int num_mem_params, struct mem_param *mem_params,
+               int num_reg_params, struct reg_param *reg_params,
+               uint32_t entry_point, uint32_t exit_point,
+               int timeout_ms, void *arch_info);
+
+int armv7m_start_algorithm(struct target *target,
+               int num_mem_params, struct mem_param *mem_params,
+               int num_reg_params, struct reg_param *reg_params,
+               uint32_t entry_point, uint32_t exit_point,
+               void *arch_info);
+
+int armv7m_wait_algorithm(struct target *target,
+               int num_mem_params, struct mem_param *mem_params,
+               int num_reg_params, struct reg_param *reg_params,
+               uint32_t exit_point, int timeout_ms,
+               void *arch_info);
+
+int armv7m_invalidate_core_regs(struct target *target);
+
+int armv7m_restore_context(struct target *target);
+
+int armv7m_checksum_memory(struct target *target,
+               uint32_t address, uint32_t count, uint32_t *checksum);
+int armv7m_blank_check_memory(struct target *target,
+               uint32_t address, uint32_t count, uint32_t *blank);
+
+int armv7m_maybe_skip_bkpt_inst(struct target *target, bool *inst_found);
+
+extern const struct command_registration armv7m_command_handlers[];
 
 #endif /* ARMV7M_H */