aboutsummaryrefslogtreecommitdiff
path: root/src/target/armv7m.h
blob: f5679b91d9b1259c32596ae3165bd3c58e73d0fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/***************************************************************************
 *   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     *
 *   (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, see <http://www.gnu.org/licenses/>. *
 ***************************************************************************/

#ifndef OPENOCD_TARGET_ARMV7M_H
#define OPENOCD_TARGET_ARMV7M_H

#include "arm_adi_v5.h"
#include "arm.h"
#include "armv7m_trace.h"

extern const int armv7m_psp_reg_map[];
extern const int armv7m_msp_reg_map[];

const char *armv7m_exception_string(int number);

/* Cortex-M DCRSR.REGSEL selectors */
enum {
	ARMV7M_REGSEL_R0,
	ARMV7M_REGSEL_R1,
	ARMV7M_REGSEL_R2,
	ARMV7M_REGSEL_R3,

	ARMV7M_REGSEL_R4,
	ARMV7M_REGSEL_R5,
	ARMV7M_REGSEL_R6,
	ARMV7M_REGSEL_R7,

	ARMV7M_REGSEL_R8,
	ARMV7M_REGSEL_R9,
	ARMV7M_REGSEL_R10,
	ARMV7M_REGSEL_R11,

	ARMV7M_REGSEL_R12,
	ARMV7M_REGSEL_R13,
	ARMV7M_REGSEL_R14,
	ARMV7M_REGSEL_PC = 15,

	ARMV7M_REGSEL_xPSR = 16,
	ARMV7M_REGSEL_MSP,
	ARMV7M_REGSEL_PSP,

	ARMV7M_REGSEL_PMSK_BPRI_FLTMSK_CTRL = 0x14,
	ARMV7M_REGSEL_FPSCR = 0x21,

	/* 32bit Floating-point registers */
	ARMV7M_REGSEL_S0 = 0x40,
	ARMV7M_REGSEL_S1,
	ARMV7M_REGSEL_S2,
	ARMV7M_REGSEL_S3,
	ARMV7M_REGSEL_S4,
	ARMV7M_REGSEL_S5,
	ARMV7M_REGSEL_S6,
	ARMV7M_REGSEL_S7,
	ARMV7M_REGSEL_S8,
	ARMV7M_REGSEL_S9,
	ARMV7M_REGSEL_S10,
	ARMV7M_REGSEL_S11,
	ARMV7M_REGSEL_S12,
	ARMV7M_REGSEL_S13,
	ARMV7M_REGSEL_S14,
	ARMV7M_REGSEL_S15,
	ARMV7M_REGSEL_S16,
	ARMV7M_REGSEL_S17,
	ARMV7M_REGSEL_S18,
	ARMV7M_REGSEL_S19,
	ARMV7M_REGSEL_S20,
	ARMV7M_REGSEL_S21,
	ARMV7M_REGSEL_S22,
	ARMV7M_REGSEL_S23,
	ARMV7M_REGSEL_S24,
	ARMV7M_REGSEL_S25,
	ARMV7M_REGSEL_S26,
	ARMV7M_REGSEL_S27,
	ARMV7M_REGSEL_S28,
	ARMV7M_REGSEL_S29,
	ARMV7M_REGSEL_S30,
	ARMV7M_REGSEL_S31,
};

/* offsets into armv7m core register cache */
enum {
	/* for convenience, the first set of indices match
	 * the Cortex-M DCRSR.REGSEL selectors
	 */
	ARMV7M_R0 = ARMV7M_REGSEL_R0,
	ARMV7M_R1 = ARMV7M_REGSEL_R1,
	ARMV7M_R2 = ARMV7M_REGSEL_R2,
	ARMV7M_R3 = ARMV7M_REGSEL_R3,

	ARMV7M_R4 = ARMV7M_REGSEL_R4,
	ARMV7M_R5 = ARMV7M_REGSEL_R5,
	ARMV7M_R6 = ARMV7M_REGSEL_R6,
	ARMV7M_R7 = ARMV7M_REGSEL_R7,

	ARMV7M_R8 = ARMV7M_REGSEL_R8,
	ARMV7M_R9 = ARMV7M_REGSEL_R9,
	ARMV7M_R10 = ARMV7M_REGSEL_R10,
	ARMV7M_R11 = ARMV7M_REGSEL_R11,

	ARMV7M_R12 = ARMV7M_REGSEL_R12,
	ARMV7M_R13 = ARMV7M_REGSEL_R13,
	ARMV7M_R14 = ARMV7M_REGSEL_R14,
	ARMV7M_PC = ARMV7M_REGSEL_PC,

	ARMV7M_xPSR = ARMV7M_REGSEL_xPSR,
	ARMV7M_MSP = ARMV7M_REGSEL_MSP,
	ARMV7M_PSP = ARMV7M_REGSEL_PSP,

	/* following indices are arbitrary, do not match DCRSR.REGSEL selectors */

	/* working register for packing/unpacking special regs, hidden from gdb */
	ARMV7M_PMSK_BPRI_FLTMSK_CTRL,

	/* WARNING: If you use armv7m_write_core_reg() on one of 4 following
	 * special registers, the new data go to ARMV7M_PMSK_BPRI_FLTMSK_CTRL
	 * cache only and are not flushed to CPU HW register.
	 * To trigger write to CPU HW register, add
	 *		armv7m_write_core_reg(,,ARMV7M_PMSK_BPRI_FLTMSK_CTRL,);
	 */
	ARMV7M_PRIMASK,
	ARMV7M_BASEPRI,
	ARMV7M_FAULTMASK,
	ARMV7M_CONTROL,

	/* 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 register */
	ARMV7M_FPSCR,

	ARMV7M_LAST_REG,
};

enum {
	FP_NONE = 0,
	FPV4_SP,
	FPV5_SP,
	FPV5_DP,
};

#define ARMV7M_NUM_CORE_REGS (ARMV7M_xPSR + 1)
#define ARMV7M_NUM_CORE_REGS_NOFP (ARMV7M_CONTROL + 1)

#define ARMV7M_COMMON_MAGIC 0x2A452A45

struct armv7m_common {
	struct arm	arm;

	int common_magic;
	int exception_number;

	/* AP this processor is connected to in the DAP */
	struct adiv5_ap *debug_ap;

	int fp_feature;
	uint32_t demcr;

	/* stlink is a high level adapter, does not support all functions */
	bool stlink;

	struct armv7m_trace_config trace_config;

	/* Direct processor core register read and writes */
	int (*load_core_reg_u32)(struct target *target, uint32_t regsel, uint32_t *value);
	int (*store_core_reg_u32)(struct target *target, uint32_t regsel, uint32_t value);

	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)
{
	return container_of(target->arch_info, struct armv7m_common, arm);
}

static inline bool is_armv7m(const struct armv7m_common *armv7m)
{
	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);
void armv7m_free_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,
		enum target_register_class reg_class);

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,
		target_addr_t entry_point, target_addr_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,
		target_addr_t entry_point, target_addr_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,
		target_addr_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,
		target_addr_t address, uint32_t count, uint32_t *checksum);
int armv7m_blank_check_memory(struct target *target,
		struct target_memory_check_block *blocks, int num_blocks, uint8_t erased_value);

int armv7m_maybe_skip_bkpt_inst(struct target *target, bool *inst_found);

extern const struct command_registration armv7m_command_handlers[];

#endif /* OPENOCD_TARGET_ARMV7M_H */