ecca0e752466e1f143be0da7bb3b59542e61cd12
[openocd.git] / src / target / armv7m.c
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 * Copyright (C) 2007,2008 √ėyvind Harboe *
12 * oyvind.harboe@zylin.com *
13 * *
14 * Copyright (C) 2018 by Liviu Ionescu *
15 * <ilg@livius.net> *
16 * *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
21 * *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
26 * *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
29 * *
30 * ARMv7-M Architecture, Application Level Reference Manual *
31 * ARM DDI 0405C (September 2008) *
32 * *
33 ***************************************************************************/
34
35 #ifdef HAVE_CONFIG_H
36 #include "config.h"
37 #endif
38
39 #include "breakpoints.h"
40 #include "armv7m.h"
41 #include "algorithm.h"
42 #include "register.h"
43 #include "semihosting_common.h"
44
45 #if 0
46 #define _DEBUG_INSTRUCTION_EXECUTION_
47 #endif
48
49 static const char * const armv7m_exception_strings[] = {
50 "", "Reset", "NMI", "HardFault",
51 "MemManage", "BusFault", "UsageFault", "RESERVED",
52 "RESERVED", "RESERVED", "RESERVED", "SVCall",
53 "DebugMonitor", "RESERVED", "PendSV", "SysTick"
54 };
55
56 /* PSP is used in some thread modes */
57 const int armv7m_psp_reg_map[ARMV7M_NUM_CORE_REGS] = {
58 ARMV7M_R0, ARMV7M_R1, ARMV7M_R2, ARMV7M_R3,
59 ARMV7M_R4, ARMV7M_R5, ARMV7M_R6, ARMV7M_R7,
60 ARMV7M_R8, ARMV7M_R9, ARMV7M_R10, ARMV7M_R11,
61 ARMV7M_R12, ARMV7M_PSP, ARMV7M_R14, ARMV7M_PC,
62 ARMV7M_xPSR,
63 };
64
65 /* MSP is used in handler and some thread modes */
66 const int armv7m_msp_reg_map[ARMV7M_NUM_CORE_REGS] = {
67 ARMV7M_R0, ARMV7M_R1, ARMV7M_R2, ARMV7M_R3,
68 ARMV7M_R4, ARMV7M_R5, ARMV7M_R6, ARMV7M_R7,
69 ARMV7M_R8, ARMV7M_R9, ARMV7M_R10, ARMV7M_R11,
70 ARMV7M_R12, ARMV7M_MSP, ARMV7M_R14, ARMV7M_PC,
71 ARMV7M_xPSR,
72 };
73
74 /*
75 * These registers are not memory-mapped. The ARMv7-M profile includes
76 * memory mapped registers too, such as for the NVIC (interrupt controller)
77 * and SysTick (timer) modules; those can mostly be treated as peripherals.
78 *
79 * The ARMv6-M profile is almost identical in this respect, except that it
80 * doesn't include basepri or faultmask registers.
81 */
82 static const struct {
83 unsigned id;
84 const char *name;
85 unsigned bits;
86 enum reg_type type;
87 const char *group;
88 const char *feature;
89 } armv7m_regs[] = {
90 { ARMV7M_R0, "r0", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
91 { ARMV7M_R1, "r1", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
92 { ARMV7M_R2, "r2", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
93 { ARMV7M_R3, "r3", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
94 { ARMV7M_R4, "r4", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
95 { ARMV7M_R5, "r5", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
96 { ARMV7M_R6, "r6", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
97 { ARMV7M_R7, "r7", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
98 { ARMV7M_R8, "r8", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
99 { ARMV7M_R9, "r9", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
100 { ARMV7M_R10, "r10", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
101 { ARMV7M_R11, "r11", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
102 { ARMV7M_R12, "r12", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
103 { ARMV7M_R13, "sp", 32, REG_TYPE_DATA_PTR, "general", "org.gnu.gdb.arm.m-profile" },
104 { ARMV7M_R14, "lr", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
105 { ARMV7M_PC, "pc", 32, REG_TYPE_CODE_PTR, "general", "org.gnu.gdb.arm.m-profile" },
106 { ARMV7M_xPSR, "xPSR", 32, REG_TYPE_INT, "general", "org.gnu.gdb.arm.m-profile" },
107
108 { ARMV7M_MSP, "msp", 32, REG_TYPE_DATA_PTR, "system", "org.gnu.gdb.arm.m-system" },
109 { ARMV7M_PSP, "psp", 32, REG_TYPE_DATA_PTR, "system", "org.gnu.gdb.arm.m-system" },
110
111 { ARMV7M_PRIMASK, "primask", 1, REG_TYPE_INT8, "system", "org.gnu.gdb.arm.m-system" },
112 { ARMV7M_BASEPRI, "basepri", 8, REG_TYPE_INT8, "system", "org.gnu.gdb.arm.m-system" },
113 { ARMV7M_FAULTMASK, "faultmask", 1, REG_TYPE_INT8, "system", "org.gnu.gdb.arm.m-system" },
114 { ARMV7M_CONTROL, "control", 2, REG_TYPE_INT8, "system", "org.gnu.gdb.arm.m-system" },
115
116 { ARMV7M_D0, "d0", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
117 { ARMV7M_D1, "d1", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
118 { ARMV7M_D2, "d2", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
119 { ARMV7M_D3, "d3", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
120 { ARMV7M_D4, "d4", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
121 { ARMV7M_D5, "d5", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
122 { ARMV7M_D6, "d6", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
123 { ARMV7M_D7, "d7", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
124 { ARMV7M_D8, "d8", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
125 { ARMV7M_D9, "d9", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
126 { ARMV7M_D10, "d10", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
127 { ARMV7M_D11, "d11", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
128 { ARMV7M_D12, "d12", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
129 { ARMV7M_D13, "d13", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
130 { ARMV7M_D14, "d14", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
131 { ARMV7M_D15, "d15", 64, REG_TYPE_IEEE_DOUBLE, "float", "org.gnu.gdb.arm.vfp" },
132
133 { ARMV7M_FPSCR, "fpscr", 32, REG_TYPE_INT, "float", "org.gnu.gdb.arm.vfp" },
134 };
135
136 #define ARMV7M_NUM_REGS ARRAY_SIZE(armv7m_regs)
137
138 /**
139 * Restores target context using the cache of core registers set up
140 * by armv7m_build_reg_cache(), calling optional core-specific hooks.
141 */
142 int armv7m_restore_context(struct target *target)
143 {
144 int i;
145 struct armv7m_common *armv7m = target_to_armv7m(target);
146 struct reg_cache *cache = armv7m->arm.core_cache;
147
148 LOG_DEBUG(" ");
149
150 if (armv7m->pre_restore_context)
151 armv7m->pre_restore_context(target);
152
153 for (i = cache->num_regs - 1; i >= 0; i--) {
154 if (cache->reg_list[i].dirty) {
155 armv7m->arm.write_core_reg(target, &cache->reg_list[i], i,
156 ARM_MODE_ANY, cache->reg_list[i].value);
157 }
158 }
159
160 return ERROR_OK;
161 }
162
163 /* Core state functions */
164
165 /**
166 * Maps ISR number (from xPSR) to name.
167 * Note that while names and meanings for the first sixteen are standardized
168 * (with zero not a true exception), external interrupts are only numbered.
169 * They are assigned by vendors, which generally assign different numbers to
170 * peripherals (such as UART0 or a USB peripheral controller).
171 */
172 const char *armv7m_exception_string(int number)
173 {
174 static char enamebuf[32];
175
176 if ((number < 0) | (number > 511))
177 return "Invalid exception";
178 if (number < 16)
179 return armv7m_exception_strings[number];
180 sprintf(enamebuf, "External Interrupt(%i)", number - 16);
181 return enamebuf;
182 }
183
184 static int armv7m_get_core_reg(struct reg *reg)
185 {
186 int retval;
187 struct arm_reg *armv7m_reg = reg->arch_info;
188 struct target *target = armv7m_reg->target;
189 struct arm *arm = target_to_arm(target);
190
191 if (target->state != TARGET_HALTED)
192 return ERROR_TARGET_NOT_HALTED;
193
194 retval = arm->read_core_reg(target, reg, armv7m_reg->num, arm->core_mode);
195
196 return retval;
197 }
198
199 static int armv7m_set_core_reg(struct reg *reg, uint8_t *buf)
200 {
201 struct arm_reg *armv7m_reg = reg->arch_info;
202 struct target *target = armv7m_reg->target;
203
204 if (target->state != TARGET_HALTED)
205 return ERROR_TARGET_NOT_HALTED;
206
207 buf_cpy(buf, reg->value, reg->size);
208 reg->dirty = 1;
209 reg->valid = 1;
210
211 return ERROR_OK;
212 }
213
214 static int armv7m_read_core_reg(struct target *target, struct reg *r,
215 int num, enum arm_mode mode)
216 {
217 uint32_t reg_value;
218 int retval;
219 struct arm_reg *armv7m_core_reg;
220 struct armv7m_common *armv7m = target_to_armv7m(target);
221
222 assert(num < (int)armv7m->arm.core_cache->num_regs);
223
224 armv7m_core_reg = armv7m->arm.core_cache->reg_list[num].arch_info;
225
226 if ((armv7m_core_reg->num >= ARMV7M_D0) && (armv7m_core_reg->num <= ARMV7M_D15)) {
227 /* map D0..D15 to S0..S31 */
228 size_t regidx = ARMV7M_S0 + 2 * (armv7m_core_reg->num - ARMV7M_D0);
229 retval = armv7m->load_core_reg_u32(target, regidx, &reg_value);
230 if (retval != ERROR_OK)
231 return retval;
232 buf_set_u32(armv7m->arm.core_cache->reg_list[num].value,
233 0, 32, reg_value);
234 retval = armv7m->load_core_reg_u32(target, regidx + 1, &reg_value);
235 if (retval != ERROR_OK)
236 return retval;
237 buf_set_u32(armv7m->arm.core_cache->reg_list[num].value + 4,
238 0, 32, reg_value);
239 } else {
240 retval = armv7m->load_core_reg_u32(target,
241 armv7m_core_reg->num, &reg_value);
242 if (retval != ERROR_OK)
243 return retval;
244 buf_set_u32(armv7m->arm.core_cache->reg_list[num].value, 0, 32, reg_value);
245 }
246
247 armv7m->arm.core_cache->reg_list[num].valid = 1;
248 armv7m->arm.core_cache->reg_list[num].dirty = 0;
249
250 return retval;
251 }
252
253 static int armv7m_write_core_reg(struct target *target, struct reg *r,
254 int num, enum arm_mode mode, uint8_t *value)
255 {
256 int retval;
257 struct arm_reg *armv7m_core_reg;
258 struct armv7m_common *armv7m = target_to_armv7m(target);
259
260 assert(num < (int)armv7m->arm.core_cache->num_regs);
261
262 armv7m_core_reg = armv7m->arm.core_cache->reg_list[num].arch_info;
263
264 if ((armv7m_core_reg->num >= ARMV7M_D0) && (armv7m_core_reg->num <= ARMV7M_D15)) {
265 /* map D0..D15 to S0..S31 */
266 size_t regidx = ARMV7M_S0 + 2 * (armv7m_core_reg->num - ARMV7M_D0);
267
268 uint32_t t = buf_get_u32(value, 0, 32);
269 retval = armv7m->store_core_reg_u32(target, regidx, t);
270 if (retval != ERROR_OK)
271 goto out_error;
272
273 t = buf_get_u32(value + 4, 0, 32);
274 retval = armv7m->store_core_reg_u32(target, regidx + 1, t);
275 if (retval != ERROR_OK)
276 goto out_error;
277 } else {
278 uint32_t t = buf_get_u32(value, 0, 32);
279
280 LOG_DEBUG("write core reg %i value 0x%" PRIx32 "", num, t);
281 retval = armv7m->store_core_reg_u32(target, armv7m_core_reg->num, t);
282 if (retval != ERROR_OK)
283 goto out_error;
284 }
285
286 armv7m->arm.core_cache->reg_list[num].valid = 1;
287 armv7m->arm.core_cache->reg_list[num].dirty = 0;
288
289 return ERROR_OK;
290
291 out_error:
292 LOG_ERROR("Error setting register");
293 armv7m->arm.core_cache->reg_list[num].dirty = armv7m->arm.core_cache->reg_list[num].valid;
294 return ERROR_JTAG_DEVICE_ERROR;
295 }
296
297 /**
298 * Returns generic ARM userspace registers to GDB.
299 */
300 int armv7m_get_gdb_reg_list(struct target *target, struct reg **reg_list[],
301 int *reg_list_size, enum target_register_class reg_class)
302 {
303 struct armv7m_common *armv7m = target_to_armv7m(target);
304 int i;
305
306 if (reg_class == REG_CLASS_ALL)
307 *reg_list_size = armv7m->arm.core_cache->num_regs;
308 else
309 *reg_list_size = ARMV7M_NUM_CORE_REGS;
310
311 *reg_list = malloc(sizeof(struct reg *) * (*reg_list_size));
312 if (*reg_list == NULL)
313 return ERROR_FAIL;
314
315 for (i = 0; i < *reg_list_size; i++)
316 (*reg_list)[i] = &armv7m->arm.core_cache->reg_list[i];
317
318 return ERROR_OK;
319 }
320
321 /** Runs a Thumb algorithm in the target. */
322 int armv7m_run_algorithm(struct target *target,
323 int num_mem_params, struct mem_param *mem_params,
324 int num_reg_params, struct reg_param *reg_params,
325 target_addr_t entry_point, target_addr_t exit_point,
326 int timeout_ms, void *arch_info)
327 {
328 int retval;
329
330 retval = armv7m_start_algorithm(target,
331 num_mem_params, mem_params,
332 num_reg_params, reg_params,
333 entry_point, exit_point,
334 arch_info);
335
336 if (retval == ERROR_OK)
337 retval = armv7m_wait_algorithm(target,
338 num_mem_params, mem_params,
339 num_reg_params, reg_params,
340 exit_point, timeout_ms,
341 arch_info);
342
343 return retval;
344 }
345
346 /** Starts a Thumb algorithm in the target. */
347 int armv7m_start_algorithm(struct target *target,
348 int num_mem_params, struct mem_param *mem_params,
349 int num_reg_params, struct reg_param *reg_params,
350 target_addr_t entry_point, target_addr_t exit_point,
351 void *arch_info)
352 {
353 struct armv7m_common *armv7m = target_to_armv7m(target);
354 struct armv7m_algorithm *armv7m_algorithm_info = arch_info;
355 enum arm_mode core_mode = armv7m->arm.core_mode;
356 int retval = ERROR_OK;
357
358 /* NOTE: armv7m_run_algorithm requires that each algorithm uses a software breakpoint
359 * at the exit point */
360
361 if (armv7m_algorithm_info->common_magic != ARMV7M_COMMON_MAGIC) {
362 LOG_ERROR("current target isn't an ARMV7M target");
363 return ERROR_TARGET_INVALID;
364 }
365
366 if (target->state != TARGET_HALTED) {
367 LOG_WARNING("target not halted");
368 return ERROR_TARGET_NOT_HALTED;
369 }
370
371 /* refresh core register cache
372 * Not needed if core register cache is always consistent with target process state */
373 for (unsigned i = 0; i < armv7m->arm.core_cache->num_regs; i++) {
374
375 armv7m_algorithm_info->context[i] = buf_get_u32(
376 armv7m->arm.core_cache->reg_list[i].value,
377 0,
378 32);
379 }
380
381 for (int i = 0; i < num_mem_params; i++) {
382 /* TODO: Write only out params */
383 retval = target_write_buffer(target, mem_params[i].address,
384 mem_params[i].size,
385 mem_params[i].value);
386 if (retval != ERROR_OK)
387 return retval;
388 }
389
390 for (int i = 0; i < num_reg_params; i++) {
391 if (reg_params[i].direction == PARAM_IN)
392 continue;
393
394 struct reg *reg =
395 register_get_by_name(armv7m->arm.core_cache, reg_params[i].reg_name, 0);
396 /* uint32_t regvalue; */
397
398 if (!reg) {
399 LOG_ERROR("BUG: register '%s' not found", reg_params[i].reg_name);
400 return ERROR_COMMAND_SYNTAX_ERROR;
401 }
402
403 if (reg->size != reg_params[i].size) {
404 LOG_ERROR("BUG: register '%s' size doesn't match reg_params[i].size",
405 reg_params[i].reg_name);
406 return ERROR_COMMAND_SYNTAX_ERROR;
407 }
408
409 /* regvalue = buf_get_u32(reg_params[i].value, 0, 32); */
410 armv7m_set_core_reg(reg, reg_params[i].value);
411 }
412
413 {
414 /*
415 * Ensure xPSR.T is set to avoid trying to run things in arm
416 * (non-thumb) mode, which armv7m does not support.
417 *
418 * We do this by setting the entirety of xPSR, which should
419 * remove all the unknowns about xPSR state.
420 *
421 * Because xPSR.T is populated on reset from the vector table,
422 * it might be 0 if the vector table has "bad" data in it.
423 */
424 struct reg *reg = &armv7m->arm.core_cache->reg_list[ARMV7M_xPSR];
425 buf_set_u32(reg->value, 0, 32, 0x01000000);
426 reg->valid = 1;
427 reg->dirty = 1;
428 }
429
430 if (armv7m_algorithm_info->core_mode != ARM_MODE_ANY &&
431 armv7m_algorithm_info->core_mode != core_mode) {
432
433 /* we cannot set ARM_MODE_HANDLER, so use ARM_MODE_THREAD instead */
434 if (armv7m_algorithm_info->core_mode == ARM_MODE_HANDLER) {
435 armv7m_algorithm_info->core_mode = ARM_MODE_THREAD;
436 LOG_INFO("ARM_MODE_HANDLER not currently supported, using ARM_MODE_THREAD instead");
437 }
438
439 LOG_DEBUG("setting core_mode: 0x%2.2x", armv7m_algorithm_info->core_mode);
440 buf_set_u32(armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].value,
441 0, 1, armv7m_algorithm_info->core_mode);
442 armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].dirty = 1;
443 armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].valid = 1;
444 }
445
446 /* save previous core mode */
447 armv7m_algorithm_info->core_mode = core_mode;
448
449 retval = target_resume(target, 0, entry_point, 1, 1);
450
451 return retval;
452 }
453
454 /** Waits for an algorithm in the target. */
455 int armv7m_wait_algorithm(struct target *target,
456 int num_mem_params, struct mem_param *mem_params,
457 int num_reg_params, struct reg_param *reg_params,
458 target_addr_t exit_point, int timeout_ms,
459 void *arch_info)
460 {
461 struct armv7m_common *armv7m = target_to_armv7m(target);
462 struct armv7m_algorithm *armv7m_algorithm_info = arch_info;
463 int retval = ERROR_OK;
464 uint32_t pc;
465
466 /* NOTE: armv7m_run_algorithm requires that each algorithm uses a software breakpoint
467 * at the exit point */
468
469 if (armv7m_algorithm_info->common_magic != ARMV7M_COMMON_MAGIC) {
470 LOG_ERROR("current target isn't an ARMV7M target");
471 return ERROR_TARGET_INVALID;
472 }
473
474 retval = target_wait_state(target, TARGET_HALTED, timeout_ms);
475 /* If the target fails to halt due to the breakpoint, force a halt */
476 if (retval != ERROR_OK || target->state != TARGET_HALTED) {
477 retval = target_halt(target);
478 if (retval != ERROR_OK)
479 return retval;
480 retval = target_wait_state(target, TARGET_HALTED, 500);
481 if (retval != ERROR_OK)
482 return retval;
483 return ERROR_TARGET_TIMEOUT;
484 }
485
486 armv7m->load_core_reg_u32(target, 15, &pc);
487 if (exit_point && (pc != exit_point)) {
488 LOG_DEBUG("failed algorithm halted at 0x%" PRIx32 ", expected 0x%" TARGET_PRIxADDR,
489 pc,
490 exit_point);
491 return ERROR_TARGET_TIMEOUT;
492 }
493
494 /* Read memory values to mem_params[] */
495 for (int i = 0; i < num_mem_params; i++) {
496 if (mem_params[i].direction != PARAM_OUT) {
497 retval = target_read_buffer(target, mem_params[i].address,
498 mem_params[i].size,
499 mem_params[i].value);
500 if (retval != ERROR_OK)
501 return retval;
502 }
503 }
504
505 /* Copy core register values to reg_params[] */
506 for (int i = 0; i < num_reg_params; i++) {
507 if (reg_params[i].direction != PARAM_OUT) {
508 struct reg *reg = register_get_by_name(armv7m->arm.core_cache,
509 reg_params[i].reg_name,
510 0);
511
512 if (!reg) {
513 LOG_ERROR("BUG: register '%s' not found", reg_params[i].reg_name);
514 return ERROR_COMMAND_SYNTAX_ERROR;
515 }
516
517 if (reg->size != reg_params[i].size) {
518 LOG_ERROR(
519 "BUG: register '%s' size doesn't match reg_params[i].size",
520 reg_params[i].reg_name);
521 return ERROR_COMMAND_SYNTAX_ERROR;
522 }
523
524 buf_set_u32(reg_params[i].value, 0, 32, buf_get_u32(reg->value, 0, 32));
525 }
526 }
527
528 for (int i = armv7m->arm.core_cache->num_regs - 1; i >= 0; i--) {
529 uint32_t regvalue;
530 regvalue = buf_get_u32(armv7m->arm.core_cache->reg_list[i].value, 0, 32);
531 if (regvalue != armv7m_algorithm_info->context[i]) {
532 LOG_DEBUG("restoring register %s with value 0x%8.8" PRIx32,
533 armv7m->arm.core_cache->reg_list[i].name,
534 armv7m_algorithm_info->context[i]);
535 buf_set_u32(armv7m->arm.core_cache->reg_list[i].value,
536 0, 32, armv7m_algorithm_info->context[i]);
537 armv7m->arm.core_cache->reg_list[i].valid = 1;
538 armv7m->arm.core_cache->reg_list[i].dirty = 1;
539 }
540 }
541
542 /* restore previous core mode */
543 if (armv7m_algorithm_info->core_mode != armv7m->arm.core_mode) {
544 LOG_DEBUG("restoring core_mode: 0x%2.2x", armv7m_algorithm_info->core_mode);
545 buf_set_u32(armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].value,
546 0, 1, armv7m_algorithm_info->core_mode);
547 armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].dirty = 1;
548 armv7m->arm.core_cache->reg_list[ARMV7M_CONTROL].valid = 1;
549 }
550
551 armv7m->arm.core_mode = armv7m_algorithm_info->core_mode;
552
553 return retval;
554 }
555
556 /** Logs summary of ARMv7-M state for a halted target. */
557 int armv7m_arch_state(struct target *target)
558 {
559 struct armv7m_common *armv7m = target_to_armv7m(target);
560 struct arm *arm = &armv7m->arm;
561 uint32_t ctrl, sp;
562
563 /* avoid filling log waiting for fileio reply */
564 if (target->semihosting && target->semihosting->hit_fileio)
565 return ERROR_OK;
566
567 ctrl = buf_get_u32(arm->core_cache->reg_list[ARMV7M_CONTROL].value, 0, 32);
568 sp = buf_get_u32(arm->core_cache->reg_list[ARMV7M_R13].value, 0, 32);
569
570 LOG_USER("target halted due to %s, current mode: %s %s\n"
571 "xPSR: %#8.8" PRIx32 " pc: %#8.8" PRIx32 " %csp: %#8.8" PRIx32 "%s%s",
572 debug_reason_name(target),
573 arm_mode_name(arm->core_mode),
574 armv7m_exception_string(armv7m->exception_number),
575 buf_get_u32(arm->cpsr->value, 0, 32),
576 buf_get_u32(arm->pc->value, 0, 32),
577 (ctrl & 0x02) ? 'p' : 'm',
578 sp,
579 (target->semihosting && target->semihosting->is_active) ? ", semihosting" : "",
580 (target->semihosting && target->semihosting->is_fileio) ? " fileio" : "");
581
582 return ERROR_OK;
583 }
584
585 static const struct reg_arch_type armv7m_reg_type = {
586 .get = armv7m_get_core_reg,
587 .set = armv7m_set_core_reg,
588 };
589
590 /** Builds cache of architecturally defined registers. */
591 struct reg_cache *armv7m_build_reg_cache(struct target *target)
592 {
593 struct armv7m_common *armv7m = target_to_armv7m(target);
594 struct arm *arm = &armv7m->arm;
595 int num_regs = ARMV7M_NUM_REGS;
596 struct reg_cache **cache_p = register_get_last_cache_p(&target->reg_cache);
597 struct reg_cache *cache = malloc(sizeof(struct reg_cache));
598 struct reg *reg_list = calloc(num_regs, sizeof(struct reg));
599 struct arm_reg *arch_info = calloc(num_regs, sizeof(struct arm_reg));
600 struct reg_feature *feature;
601 int i;
602
603 /* Build the process context cache */
604 cache->name = "arm v7m registers";
605 cache->next = NULL;
606 cache->reg_list = reg_list;
607 cache->num_regs = num_regs;
608 (*cache_p) = cache;
609
610 for (i = 0; i < num_regs; i++) {
611 arch_info[i].num = armv7m_regs[i].id;
612 arch_info[i].target = target;
613 arch_info[i].arm = arm;
614
615 reg_list[i].name = armv7m_regs[i].name;
616 reg_list[i].size = armv7m_regs[i].bits;
617 size_t storage_size = DIV_ROUND_UP(armv7m_regs[i].bits, 8);
618 if (storage_size < 4)
619 storage_size = 4;
620 reg_list[i].value = calloc(1, storage_size);
621 reg_list[i].dirty = 0;
622 reg_list[i].valid = 0;
623 reg_list[i].type = &armv7m_reg_type;
624 reg_list[i].arch_info = &arch_info[i];
625
626 reg_list[i].group = armv7m_regs[i].group;
627 reg_list[i].number = i;
628 reg_list[i].exist = true;
629 reg_list[i].caller_save = true; /* gdb defaults to true */
630
631 feature = calloc(1, sizeof(struct reg_feature));
632 if (feature) {
633 feature->name = armv7m_regs[i].feature;
634 reg_list[i].feature = feature;
635 } else
636 LOG_ERROR("unable to allocate feature list");
637
638 reg_list[i].reg_data_type = calloc(1, sizeof(struct reg_data_type));
639 if (reg_list[i].reg_data_type)
640 reg_list[i].reg_data_type->type = armv7m_regs[i].type;
641 else
642 LOG_ERROR("unable to allocate reg type list");
643 }
644
645 arm->cpsr = reg_list + ARMV7M_xPSR;
646 arm->pc = reg_list + ARMV7M_PC;
647 arm->core_cache = cache;
648
649 return cache;
650 }
651
652 void armv7m_free_reg_cache(struct target *target)
653 {
654 struct armv7m_common *armv7m = target_to_armv7m(target);
655 struct arm *arm = &armv7m->arm;
656 struct reg_cache *cache;
657 struct reg *reg;
658 unsigned int i;
659
660 cache = arm->core_cache;
661
662 if (!cache)
663 return;
664
665 for (i = 0; i < cache->num_regs; i++) {
666 reg = &cache->reg_list[i];
667
668 free(reg->feature);
669 free(reg->reg_data_type);
670 free(reg->value);
671 }
672
673 free(cache->reg_list[0].arch_info);
674 free(cache->reg_list);
675 free(cache);
676
677 arm->core_cache = NULL;
678 }
679
680 static int armv7m_setup_semihosting(struct target *target, int enable)
681 {
682 /* nothing todo for armv7m */
683 return ERROR_OK;
684 }
685
686 /** Sets up target as a generic ARMv7-M core */
687 int armv7m_init_arch_info(struct target *target, struct armv7m_common *armv7m)
688 {
689 struct arm *arm = &armv7m->arm;
690
691 armv7m->common_magic = ARMV7M_COMMON_MAGIC;
692 armv7m->fp_feature = FP_NONE;
693 armv7m->trace_config.trace_bus_id = 1;
694 /* Enable stimulus port #0 by default */
695 armv7m->trace_config.itm_ter[0] = 1;
696
697 arm->core_type = ARM_MODE_THREAD;
698 arm->arch_info = armv7m;
699 arm->setup_semihosting = armv7m_setup_semihosting;
700
701 arm->read_core_reg = armv7m_read_core_reg;
702 arm->write_core_reg = armv7m_write_core_reg;
703
704 return arm_init_arch_info(target, arm);
705 }
706
707 /** Generates a CRC32 checksum of a memory region. */
708 int armv7m_checksum_memory(struct target *target,
709 target_addr_t address, uint32_t count, uint32_t *checksum)
710 {
711 struct working_area *crc_algorithm;
712 struct armv7m_algorithm armv7m_info;
713 struct reg_param reg_params[2];
714 int retval;
715
716 static const uint8_t cortex_m_crc_code[] = {
717 #include "../../contrib/loaders/checksum/armv7m_crc.inc"
718 };
719
720 retval = target_alloc_working_area(target, sizeof(cortex_m_crc_code), &crc_algorithm);
721 if (retval != ERROR_OK)
722 return retval;
723
724 retval = target_write_buffer(target, crc_algorithm->address,
725 sizeof(cortex_m_crc_code), (uint8_t *)cortex_m_crc_code);
726 if (retval != ERROR_OK)
727 goto cleanup;
728
729 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
730 armv7m_info.core_mode = ARM_MODE_THREAD;
731
732 init_reg_param(&reg_params[0], "r0", 32, PARAM_IN_OUT);
733 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
734
735 buf_set_u32(reg_params[0].value, 0, 32, address);
736 buf_set_u32(reg_params[1].value, 0, 32, count);
737
738 int timeout = 20000 * (1 + (count / (1024 * 1024)));
739
740 retval = target_run_algorithm(target, 0, NULL, 2, reg_params, crc_algorithm->address,
741 crc_algorithm->address + (sizeof(cortex_m_crc_code) - 6),
742 timeout, &armv7m_info);
743
744 if (retval == ERROR_OK)
745 *checksum = buf_get_u32(reg_params[0].value, 0, 32);
746 else
747 LOG_ERROR("error executing cortex_m crc algorithm");
748
749 destroy_reg_param(&reg_params[0]);
750 destroy_reg_param(&reg_params[1]);
751
752 cleanup:
753 target_free_working_area(target, crc_algorithm);
754
755 return retval;
756 }
757
758 /** Checks an array of memory regions whether they are erased. */
759 int armv7m_blank_check_memory(struct target *target,
760 struct target_memory_check_block *blocks, int num_blocks, uint8_t erased_value)
761 {
762 struct working_area *erase_check_algorithm;
763 struct working_area *erase_check_params;
764 struct reg_param reg_params[2];
765 struct armv7m_algorithm armv7m_info;
766 int retval;
767
768 static bool timed_out;
769
770 static const uint8_t erase_check_code[] = {
771 #include "../../contrib/loaders/erase_check/armv7m_erase_check.inc"
772 };
773
774 const uint32_t code_size = sizeof(erase_check_code);
775
776 /* make sure we have a working area */
777 if (target_alloc_working_area(target, code_size,
778 &erase_check_algorithm) != ERROR_OK)
779 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
780
781 retval = target_write_buffer(target, erase_check_algorithm->address,
782 code_size, erase_check_code);
783 if (retval != ERROR_OK)
784 goto cleanup1;
785
786 /* prepare blocks array for algo */
787 struct algo_block {
788 union {
789 uint32_t size;
790 uint32_t result;
791 };
792 uint32_t address;
793 };
794
795 uint32_t avail = target_get_working_area_avail(target);
796 int blocks_to_check = avail / sizeof(struct algo_block) - 1;
797 if (num_blocks < blocks_to_check)
798 blocks_to_check = num_blocks;
799
800 struct algo_block *params = malloc((blocks_to_check+1)*sizeof(struct algo_block));
801 if (params == NULL) {
802 retval = ERROR_FAIL;
803 goto cleanup1;
804 }
805
806 int i;
807 uint32_t total_size = 0;
808 for (i = 0; i < blocks_to_check; i++) {
809 total_size += blocks[i].size;
810 target_buffer_set_u32(target, (uint8_t *)&(params[i].size),
811 blocks[i].size / sizeof(uint32_t));
812 target_buffer_set_u32(target, (uint8_t *)&(params[i].address),
813 blocks[i].address);
814 }
815 target_buffer_set_u32(target, (uint8_t *)&(params[blocks_to_check].size), 0);
816
817 uint32_t param_size = (blocks_to_check + 1) * sizeof(struct algo_block);
818 if (target_alloc_working_area(target, param_size,
819 &erase_check_params) != ERROR_OK) {
820 retval = ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
821 goto cleanup2;
822 }
823
824 retval = target_write_buffer(target, erase_check_params->address,
825 param_size, (uint8_t *)params);
826 if (retval != ERROR_OK)
827 goto cleanup3;
828
829 uint32_t erased_word = erased_value | (erased_value << 8)
830 | (erased_value << 16) | (erased_value << 24);
831
832 LOG_DEBUG("Starting erase check of %d blocks, parameters@"
833 TARGET_ADDR_FMT, blocks_to_check, erase_check_params->address);
834
835 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
836 armv7m_info.core_mode = ARM_MODE_THREAD;
837
838 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
839 buf_set_u32(reg_params[0].value, 0, 32, erase_check_params->address);
840
841 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
842 buf_set_u32(reg_params[1].value, 0, 32, erased_word);
843
844 /* assume CPU clk at least 1 MHz */
845 int timeout = (timed_out ? 30000 : 2000) + total_size * 3 / 1000;
846
847 retval = target_run_algorithm(target,
848 0, NULL,
849 ARRAY_SIZE(reg_params), reg_params,
850 erase_check_algorithm->address,
851 erase_check_algorithm->address + (code_size - 2),
852 timeout,
853 &armv7m_info);
854
855 timed_out = retval == ERROR_TARGET_TIMEOUT;
856 if (retval != ERROR_OK && !timed_out)
857 goto cleanup4;
858
859 retval = target_read_buffer(target, erase_check_params->address,
860 param_size, (uint8_t *)params);
861 if (retval != ERROR_OK)
862 goto cleanup4;
863
864 for (i = 0; i < blocks_to_check; i++) {
865 uint32_t result = target_buffer_get_u32(target,
866 (uint8_t *)&(params[i].result));
867 if (result != 0 && result != 1)
868 break;
869
870 blocks[i].result = result;
871 }
872 if (i && timed_out)
873 LOG_INFO("Slow CPU clock: %d blocks checked, %d remain. Continuing...", i, num_blocks-i);
874
875 retval = i; /* return number of blocks really checked */
876
877 cleanup4:
878 destroy_reg_param(&reg_params[0]);
879 destroy_reg_param(&reg_params[1]);
880
881 cleanup3:
882 target_free_working_area(target, erase_check_params);
883 cleanup2:
884 free(params);
885 cleanup1:
886 target_free_working_area(target, erase_check_algorithm);
887
888 return retval;
889 }
890
891 int armv7m_maybe_skip_bkpt_inst(struct target *target, bool *inst_found)
892 {
893 struct armv7m_common *armv7m = target_to_armv7m(target);
894 struct reg *r = armv7m->arm.pc;
895 bool result = false;
896
897
898 /* if we halted last time due to a bkpt instruction
899 * then we have to manually step over it, otherwise
900 * the core will break again */
901
902 if (target->debug_reason == DBG_REASON_BREAKPOINT) {
903 uint16_t op;
904 uint32_t pc = buf_get_u32(r->value, 0, 32);
905
906 pc &= ~1;
907 if (target_read_u16(target, pc, &op) == ERROR_OK) {
908 if ((op & 0xFF00) == 0xBE00) {
909 pc = buf_get_u32(r->value, 0, 32) + 2;
910 buf_set_u32(r->value, 0, 32, pc);
911 r->dirty = true;
912 r->valid = true;
913 result = true;
914 LOG_DEBUG("Skipping over BKPT instruction");
915 }
916 }
917 }
918
919 if (inst_found)
920 *inst_found = result;
921
922 return ERROR_OK;
923 }
924
925 const struct command_registration armv7m_command_handlers[] = {
926 {
927 .chain = arm_command_handlers,
928 },
929 COMMAND_REGISTRATION_DONE
930 };

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)