armv7m.h 7.59 KB
Newer Older
1
2
3
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
oharboe's avatar
oharboe committed
4
 *                                                                         *
5
6
7
 *   Copyright (C) 2006 by Magnus Lundin                                   *
 *   lundin@mlu.mine.nu                                                    *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 *   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     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef ARMV7M_COMMON_H
#define ARMV7M_COMMON_H

29
#include "arm_adi_v5.h"
30
#include "armv4_5.h"
31

32
33
34
35
36
/* define for enabling armv7 gdb workarounds */
#if 1
#define ARMV7_GDB_HACKS
#endif

37
38
enum armv7m_mode
{
39
40
41
	ARMV7M_MODE_THREAD = 0,
	ARMV7M_MODE_USER_THREAD = 1,
	ARMV7M_MODE_HANDLER = 2,
42
43
44
	ARMV7M_MODE_ANY = -1
};

45
extern char *armv7m_mode_strings[];
46
47
48
49
50
51
52
53

enum armv7m_regtype
{
	ARMV7M_REGISTER_CORE_GP,
	ARMV7M_REGISTER_CORE_SP,
	ARMV7M_REGISTER_MEMMAP
};

54
char *armv7m_exception_string(int number);
55
56

/* offsets into armv7m core register cache */
57
enum
58
{
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
	/* for convenience, the first set of indices match
	 * the Cortex-M3 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,
80
	ARMV7M_PC = 15,
81

82
	ARMV7M_xPSR = 16,
ntfreak's avatar
ntfreak committed
83
84
	ARMV7M_MSP,
	ARMV7M_PSP,
85
86

	/* this next set of indices is arbitrary */
87
88
89
90
	ARMV7M_PRIMASK,
	ARMV7M_BASEPRI,
	ARMV7M_FAULTMASK,
	ARMV7M_CONTROL,
91
92
93
94
};

#define ARMV7M_COMMON_MAGIC 0x2A452A45

95
struct armv7m_common
96
97
{
	int common_magic;
98
	struct reg_cache *core_cache;
99
	enum armv7m_mode core_mode;
100
	int exception_number;
101
	struct swjdp_common swjdp_info;
102

103
	/* Direct processor core register read and writes */
Zachary T Welch's avatar
Zachary T Welch committed
104
105
	int (*load_core_reg_u32)(struct target *target, enum armv7m_regtype type, uint32_t num, uint32_t *value);
	int (*store_core_reg_u32)(struct target *target, enum armv7m_regtype type, uint32_t num, uint32_t value);
106
	/* register cache to processor synchronization */
107
108
	int (*read_core_reg)(struct target *target, unsigned num);
	int (*write_core_reg)(struct target *target, unsigned num);
109

Zachary T Welch's avatar
Zachary T Welch committed
110
111
	int (*examine_debug_reason)(struct target *target);
	void (*post_debug_entry)(struct target *target);
112

Zachary T Welch's avatar
Zachary T Welch committed
113
114
	void (*pre_restore_context)(struct target *target);
	void (*post_restore_context)(struct target *target);
115
};
116

117
static inline struct armv7m_common *
Zachary T Welch's avatar
Zachary T Welch committed
118
target_to_armv7m(struct target *target)
119
120
121
122
{
	return target->arch_info;
}

123
struct armv7m_algorithm
124
125
{
	int common_magic;
126

127
	enum armv7m_mode core_mode;
128
};
129

130
struct armv7m_core_reg
131
{
132
	uint32_t num;
133
	enum armv7m_regtype type;
Zachary T Welch's avatar
Zachary T Welch committed
134
	struct target *target;
135
	struct armv7m_common *armv7m_common;
136
};
137

Zachary T Welch's avatar
Zachary T Welch committed
138
struct reg_cache *armv7m_build_reg_cache(struct target *target);
139
140
enum armv7m_mode armv7m_number_to_mode(int number);
int armv7m_mode_to_number(enum armv7m_mode mode);
141

Zachary T Welch's avatar
Zachary T Welch committed
142
143
int armv7m_arch_state(struct target *target);
int armv7m_get_gdb_reg_list(struct target *target,
Zachary T Welch's avatar
Zachary T Welch committed
144
		struct reg **reg_list[], int *reg_list_size);
145

Zachary T Welch's avatar
Zachary T Welch committed
146
int armv7m_init_arch_info(struct target *target, struct armv7m_common *armv7m);
147

Zachary T Welch's avatar
Zachary T Welch committed
148
int armv7m_run_algorithm(struct target *target,
149
		int num_mem_params, struct mem_param *mem_params,
150
		int num_reg_params, struct reg_param *reg_params,
151
152
		uint32_t entry_point, uint32_t exit_point,
		int timeout_ms, void *arch_info);
153

Zachary T Welch's avatar
Zachary T Welch committed
154
int armv7m_invalidate_core_regs(struct target *target);
155

Zachary T Welch's avatar
Zachary T Welch committed
156
int armv7m_restore_context(struct target *target);
157

Zachary T Welch's avatar
Zachary T Welch committed
158
int armv7m_checksum_memory(struct target *target,
159
		uint32_t address, uint32_t count, uint32_t* checksum);
Zachary T Welch's avatar
Zachary T Welch committed
160
int armv7m_blank_check_memory(struct target *target,
161
		uint32_t address, uint32_t count, uint32_t* blank);
ntfreak's avatar
ntfreak committed
162

163
164
extern const struct command_registration armv7m_command_handlers[];

165
166
/* Thumb mode instructions
 */
167

168
169
170
171
/* Move to Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 * Rd: destination register
 * SYSm: source special register
 */
172
#define ARMV7M_T_MRS(Rd, SYSm)	((0xF3EF) | ((0x8000 | (Rd << 8) | SYSm) << 16))
173
174
175
176
177

/* Move from Register from Special Register  (Thumb mode) 32 bit Thumb2 instruction
 * Rd: source register
 * SYSm: destination special register
 */
178
#define ARMV7M_T_MSR(SYSm, Rn)	((0xF380 | (Rn << 8)) | ((0x8800 | SYSm) << 16))
179

180
/* Change Processor State. The instruction modifies the PRIMASK and FAULTMASK
181
182
 * special-purpose register values  (Thumb mode) 16 bit Thumb2 instruction
 * Rd: source register
183
 * IF:
184
185
 */
#define I_FLAG 2
186
187
188
#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))
189
190
191
192

/* Breakpoint (Thumb mode) v5 onwards
 * Im: immediate value used by debugger
 */
193
#define ARMV7M_T_BKPT(Im)	((0xBE00 | Im) | ((0xBE00 | Im) << 16))
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

/* 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))
212

213
214
215
/* Load register with PC relative addressing
 * Rd: register to load
 */
216
217
#define ARMV7M_T_LDR_PCREL(Rd)	((0x4800 | (Rd << 8)) | ((0x4800 | (Rd << 8)) << 16))

218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/* 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))

#endif /* ARMV7M_H */