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