1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2006 by Magnus Lundin *
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. *
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. *
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 ***************************************************************************/
27 #include "replacements.h"
40 #define _DEBUG_INSTRUCTION_EXECUTION_
43 char* armv7m_mode_strings[] =
48 char* armv7m_state_strings[] =
53 char* armv7m_exception_strings[] =
55 "", "Reset", "NMI", "HardFault", "MemManage", "BusFault", "UsageFault", "RESERVED", "RESERVED", "RESERVED", "RESERVED",
56 "SVCall", "DebugMonitor", "RESERVED", "PendSV", "SysTick"
59 char* armv7m_core_reg_list[] =
61 /* Registers accessed through core debug */
62 "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "r10", "r11", "r12",
65 /* Registers accessed through MSR instructions */
66 /* "apsr", "iapsr", "ipsr", "epsr", */
67 "primask", "basepri", "faultmask", "control"
70 char* armv7m_core_dbgreg_list[] =
72 /* Registers accessed through core debug */
73 "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", "r8", "r9", "r10", "r11", "r12",
76 /* Registers accessed through MSR instructions */
77 /* "dbg_apsr", "iapsr", "ipsr", "epsr", */
78 "primask", "basepri", "faultmask", "dbg_control"
81 u8 armv7m_gdb_dummy_fp_value[] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
83 reg_t armv7m_gdb_dummy_fp_reg =
85 "GDB dummy floating-point register", armv7m_gdb_dummy_fp_value, 0, 1, 96, NULL, 0, NULL, 0
88 armv7m_core_reg_t armv7m_core_reg_list_arch_info[] =
90 /* CORE_GP are accesible using the core debug registers */
91 {0, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
92 {1, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
93 {2, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
94 {3, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
95 {4, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
96 {5, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
97 {6, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
98 {7, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
99 {8, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
100 {9, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
101 {10, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
102 {11, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
103 {12, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
104 {13, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
105 {14, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
106 {15, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL},
108 {16, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL}, /* xPSR */
109 {17, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL}, /* MSP */
110 {18, ARMV7M_REGISTER_CORE_GP, ARMV7M_MODE_ANY, NULL, NULL}, /* PSP */
112 /* CORE_SP are accesible using MSR and MRS instructions */
114 {0x00, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* APSR */
115 {0x01, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* IAPSR */
116 {0x05, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* IPSR */
117 {0x06, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* EPSR */
120 {0x10, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* PRIMASK */
121 {0x11, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* BASEPRI */
122 {0x13, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL}, /* FAULTMASK */
123 {0x14, ARMV7M_REGISTER_CORE_SP, ARMV7M_MODE_ANY, NULL, NULL} /* CONTROL */
126 int armv7m_core_reg_arch_type = -1;
128 /* Keep different contexts for the process being debugged and debug algorithms */
129 enum armv7m_runcontext armv7m_get_context(target_t *target)
131 /* get pointers to arch-specific information */
132 armv7m_common_t *armv7m = target->arch_info;
134 if (armv7m->process_context == armv7m->core_cache)
135 return ARMV7M_PROCESS_CONTEXT;
136 if (armv7m->debug_context == armv7m->core_cache)
137 return ARMV7M_DEBUG_CONTEXT;
139 ERROR("Invalid runcontext");
143 int armv7m_use_context(target_t *target, enum armv7m_runcontext new_ctx)
146 /* get pointers to arch-specific information */
147 armv7m_common_t *armv7m = target->arch_info;
149 if ((target->state != TARGET_HALTED) && (target->state != TARGET_RESET))
151 WARNING("target not halted, switch context ");
152 return ERROR_TARGET_NOT_HALTED;
155 if (new_ctx == armv7m_get_context(target))
160 case ARMV7M_PROCESS_CONTEXT:
161 armv7m->core_cache = armv7m->process_context;
163 case ARMV7M_DEBUG_CONTEXT:
164 armv7m->core_cache = armv7m->debug_context;
167 ERROR("Invalid runcontext");
170 /* Mark registers in new context as dirty to force reload when run */
172 for (i = 0; i < armv7m->core_cache->num_regs-1; i++) /* EXCLUDE CONTROL TODOLATER : CHECK THIS */
174 armv7m->core_cache->reg_list[i].dirty = 1;
180 int armv7m_restore_context(target_t *target)
184 /* get pointers to arch-specific information */
185 armv7m_common_t *armv7m = target->arch_info;
189 if (armv7m->pre_restore_context)
190 armv7m->pre_restore_context(target);
192 for (i = ARMV7NUMCOREREGS-1; i >= 0; i--)
194 if (armv7m->core_cache->reg_list[i].dirty)
196 armv7m->write_core_reg(target, i);
200 if (armv7m->post_restore_context)
201 armv7m->post_restore_context(target);
207 /* Core state functions */
209 char *armv7m_exception_string(int number)
211 if ((number < 0) | (number > 511))
212 return "Invalid exception";
214 return armv7m_exception_strings[number];
215 sprintf(enamebuf, "External Interrupt(%i)", number - 16);
219 int armv7m_get_core_reg(reg_t *reg)
222 armv7m_core_reg_t *armv7m_reg = reg->arch_info;
223 target_t *target = armv7m_reg->target;
224 armv7m_common_t *armv7m_target = target->arch_info;
226 if (target->state != TARGET_HALTED)
228 return ERROR_TARGET_NOT_HALTED;
231 retval = armv7m_target->read_core_reg(target, armv7m_reg->num);
236 int armv7m_set_core_reg(reg_t *reg, u8 *buf)
238 armv7m_core_reg_t *armv7m_reg = reg->arch_info;
239 target_t *target = armv7m_reg->target;
240 u32 value = buf_get_u32(buf, 0, 32);
242 if (target->state != TARGET_HALTED)
244 return ERROR_TARGET_NOT_HALTED;
247 buf_set_u32(reg->value, 0, 32, value);
254 int armv7m_read_core_reg(struct target_s *target, int num)
258 armv7m_core_reg_t * armv7m_core_reg;
260 /* get pointers to arch-specific information */
261 armv7m_common_t *armv7m = target->arch_info;
263 if ((num < 0) || (num >= ARMV7NUMCOREREGS))
264 return ERROR_INVALID_ARGUMENTS;
266 armv7m_core_reg = armv7m->core_cache->reg_list[num].arch_info;
267 retval = armv7m->load_core_reg_u32(target, armv7m_core_reg->type, armv7m_core_reg->num, ®_value);
268 buf_set_u32(armv7m->core_cache->reg_list[num].value, 0, 32, reg_value);
269 armv7m->core_cache->reg_list[num].valid = 1;
270 armv7m->core_cache->reg_list[num].dirty = 0;
275 int armv7m_write_core_reg(struct target_s *target, int num)
279 armv7m_core_reg_t *armv7m_core_reg;
281 /* get pointers to arch-specific information */
282 armv7m_common_t *armv7m = target->arch_info;
284 if ((num < 0) || (num >= ARMV7NUMCOREREGS))
285 return ERROR_INVALID_ARGUMENTS;
287 reg_value = buf_get_u32(armv7m->core_cache->reg_list[num].value, 0, 32);
288 armv7m_core_reg = armv7m->core_cache->reg_list[num].arch_info;
289 retval = armv7m->store_core_reg_u32(target, armv7m_core_reg->type, armv7m_core_reg->num, reg_value);
290 if (retval != ERROR_OK)
292 ERROR("JTAG failure");
293 armv7m->core_cache->reg_list[num].dirty = armv7m->core_cache->reg_list[num].valid;
294 return ERROR_JTAG_DEVICE_ERROR;
296 DEBUG("write core reg %i value 0x%x", num , reg_value);
297 armv7m->core_cache->reg_list[num].valid = 1;
298 armv7m->core_cache->reg_list[num].dirty = 0;
303 int armv7m_invalidate_core_regs(target_t *target)
305 /* get pointers to arch-specific information */
306 armv7m_common_t *armv7m = target->arch_info;
309 for (i = 0; i < armv7m->core_cache->num_regs; i++)
311 armv7m->core_cache->reg_list[i].valid = 0;
312 armv7m->core_cache->reg_list[i].dirty = 0;
318 int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_size)
320 /* get pointers to arch-specific information */
321 armv7m_common_t *armv7m = target->arch_info;
325 *reg_list = malloc(sizeof(reg_t*) * (*reg_list_size));
327 /* TODOLATER correct list of registers, names ? */
328 for (i = 0; i < *reg_list_size; i++)
330 if (i < ARMV7NUMCOREREGS)
331 (*reg_list)[i] = &armv7m->process_context->reg_list[i];
332 /* (*reg_list)[i] = &armv7m->core_cache->reg_list[i]; */
334 (*reg_list)[i] = &armv7m_gdb_dummy_fp_reg;
336 /* ARMV7M is always in thumb mode, try to make GDB understand this if it does not support this arch */
337 armv7m->process_context->reg_list[15].value[0] |= 1;
338 (*reg_list)[25] = &armv7m->process_context->reg_list[ARMV7M_xPSR];
342 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)
344 /* get pointers to arch-specific information */
345 armv7m_common_t *armv7m = target->arch_info;
346 armv7m_algorithm_t *armv7m_algorithm_info = arch_info;
347 enum armv7m_state core_state = armv7m->core_state;
348 enum armv7m_mode core_mode = armv7m->core_mode;
349 int retval = ERROR_OK;
351 int exit_breakpoint_size = 0;
354 armv7m->core_state = core_state;
355 armv7m->core_mode = core_mode;
357 if (armv7m_algorithm_info->common_magic != ARMV7M_COMMON_MAGIC)
359 ERROR("current target isn't an ARMV7M target");
360 return ERROR_TARGET_INVALID;
363 if (target->state != TARGET_HALTED)
365 WARNING("target not halted");
366 return ERROR_TARGET_NOT_HALTED;
369 /* refresh core register cache */
370 /* Not needed if core register cache is always consistent with target process state */
371 armv7m_use_context(target, ARMV7M_DEBUG_CONTEXT);
373 for (i = 0; i < num_mem_params; i++)
375 target_write_buffer(target, mem_params[i].address, mem_params[i].size, mem_params[i].value);
378 for (i = 0; i < num_reg_params; i++)
380 reg_t *reg = register_get_by_name(armv7m->core_cache, reg_params[i].reg_name, 0);
385 ERROR("BUG: register '%s' not found", reg_params[i].reg_name);
389 if (reg->size != reg_params[i].size)
391 ERROR("BUG: register '%s' size doesn't match reg_params[i].size", reg_params[i].reg_name);
395 regvalue = buf_get_u32(reg_params[i].value, 0, 32);
396 armv7m_set_core_reg(reg, reg_params[i].value);
399 /* ARMV7M always runs in Thumb state */
400 exit_breakpoint_size = 2;
401 if ((retval = breakpoint_add(target, exit_point, exit_breakpoint_size, BKPT_SOFT)) != ERROR_OK)
403 ERROR("can't add breakpoint to finish algorithm execution");
404 return ERROR_TARGET_FAILURE;
407 /* This code relies on the target specific resume() and poll()->debug_entry()
408 sequence to write register values to the processor and the read them back */
409 target->type->resume(target, 0, entry_point, 1, 1);
410 target->type->poll(target);
412 while (target->state != TARGET_HALTED)
415 target->type->poll(target);
416 if ((timeout_ms -= 5) <= 0)
418 ERROR("timeout waiting for algorithm to complete, trying to halt target");
419 target->type->halt(target);
421 while (target->state != TARGET_HALTED)
424 target->type->poll(target);
425 if ((timeout_ms -= 10) <= 0)
427 ERROR("target didn't reenter debug state, exiting");
431 armv7m->load_core_reg_u32(target, ARMV7M_REGISTER_CORE_GP, 15, &pc);
432 DEBUG("failed algoritm halted at 0x%x ", pc);
433 retval = ERROR_TARGET_TIMEOUT;
437 breakpoint_remove(target, exit_point);
439 /* Read memory values to mem_params[] */
440 for (i = 0; i < num_mem_params; i++)
442 if (mem_params[i].direction != PARAM_OUT)
443 target_read_buffer(target, mem_params[i].address, mem_params[i].size, mem_params[i].value);
446 /* Copy core register values to reg_params[] */
447 for (i = 0; i < num_reg_params; i++)
449 if (reg_params[i].direction != PARAM_OUT)
451 reg_t *reg = register_get_by_name(armv7m->debug_context, reg_params[i].reg_name, 0);
455 ERROR("BUG: register '%s' not found", reg_params[i].reg_name);
459 if (reg->size != reg_params[i].size)
461 ERROR("BUG: register '%s' size doesn't match reg_params[i].size", reg_params[i].reg_name);
465 buf_set_u32(reg_params[i].value, 0, 32, buf_get_u32(reg->value, 0, 32));
472 int armv7m_arch_state(struct target_s *target)
474 /* get pointers to arch-specific information */
475 armv7m_common_t *armv7m = target->arch_info;
477 USER("target halted in %s state due to %s, current mode: %s %s\nxPSR: 0x%8.8x pc: 0x%8.8x",
478 armv7m_state_strings[armv7m->core_state],
479 target_debug_reason_strings[target->debug_reason],
480 armv7m_mode_strings[armv7m->core_mode],
481 armv7m_exception_string(armv7m->exception_number),
482 buf_get_u32(armv7m->core_cache->reg_list[ARMV7M_xPSR].value, 0, 32),
483 buf_get_u32(armv7m->core_cache->reg_list[15].value, 0, 32));
488 reg_cache_t *armv7m_build_reg_cache(target_t *target)
490 /* get pointers to arch-specific information */
491 armv7m_common_t *armv7m = target->arch_info;
493 int num_regs = ARMV7NUMCOREREGS;
494 reg_cache_t **cache_p = register_get_last_cache_p(&target->reg_cache);
495 reg_cache_t *cache = malloc(sizeof(reg_cache_t));
496 reg_t *reg_list = malloc(sizeof(reg_t) * num_regs);
497 armv7m_core_reg_t *arch_info = malloc(sizeof(armv7m_core_reg_t) * num_regs);
500 if (armv7m_core_reg_arch_type == -1)
501 armv7m_core_reg_arch_type = register_reg_arch_type(armv7m_get_core_reg, armv7m_set_core_reg);
503 /* Build the process context cache */
504 cache->name = "arm v7m registers";
506 cache->reg_list = reg_list;
507 cache->num_regs = num_regs;
509 armv7m->core_cache = cache;
510 armv7m->process_context = cache;
512 for (i = 0; i < num_regs; i++)
514 arch_info[i] = armv7m_core_reg_list_arch_info[i];
515 arch_info[i].target = target;
516 arch_info[i].armv7m_common = armv7m;
517 reg_list[i].name = armv7m_core_reg_list[i];
518 reg_list[i].size = 32;
519 reg_list[i].value = calloc(1, 4);
520 reg_list[i].dirty = 0;
521 reg_list[i].valid = 0;
522 reg_list[i].bitfield_desc = NULL;
523 reg_list[i].num_bitfields = 0;
524 reg_list[i].arch_type = armv7m_core_reg_arch_type;
525 reg_list[i].arch_info = &arch_info[i];
528 /* Build the debug context cache*/
529 cache = malloc(sizeof(reg_cache_t));
530 reg_list = malloc(sizeof(reg_t) * num_regs);
532 cache->name = "arm v7m debug registers";
534 cache->reg_list = reg_list;
535 cache->num_regs = num_regs;
536 armv7m->debug_context = cache;
537 armv7m->process_context->next = cache;
539 for (i = 0; i < num_regs; i++)
541 reg_list[i].name = armv7m_core_dbgreg_list[i];
542 reg_list[i].size = 32;
543 reg_list[i].value = calloc(1, 4);
544 reg_list[i].dirty = 0;
545 reg_list[i].valid = 0;
546 reg_list[i].bitfield_desc = NULL;
547 reg_list[i].num_bitfields = 0;
548 reg_list[i].arch_type = armv7m_core_reg_arch_type;
549 reg_list[i].arch_info = &arch_info[i];
555 int armv7m_init_target(struct command_context_s *cmd_ctx, struct target_s *target)
557 armv7m_build_reg_cache(target);
562 int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m)
564 /* register arch-specific functions */
566 target->arch_info = armv7m;
567 armv7m->core_state = ARMV7M_STATE_THUMB;
568 armv7m->read_core_reg = armv7m_read_core_reg;
569 armv7m->write_core_reg = armv7m_write_core_reg;
574 int armv7m_register_commands(struct command_context_s *cmd_ctx)
579 int armv7m_checksum_memory(struct target_s *target, u32 address, u32 count, u32* checksum)
581 working_area_t *crc_algorithm;
582 armv7m_algorithm_t armv7m_info;
583 reg_param_t reg_params[2];
586 u16 cortex_m3_crc_code[] = {
587 0x4602, /* mov r2, r0 */
588 0xF04F, 0x30FF, /* mov r0, #0xffffffff */
589 0x460B, /* mov r3, r1 */
590 0xF04F, 0x0400, /* mov r4, #0 */
591 0xE013, /* b ncomp */
593 0x5D11, /* ldrb r1, [r2, r4] */
594 0xF8DF, 0x7028, /* ldr r7, CRC32XOR */
595 0xEA80, 0x6001, /* eor r0, r0, r1, asl #24 */
597 0xF04F, 0x0500, /* mov r5, #0 */
599 0x2800, /* cmp r0, #0 */
600 0xEA4F, 0x0640, /* mov r6, r0, asl #1 */
601 0xF105, 0x0501, /* add r5, r5, #1 */
602 0x4630, /* mov r0, r6 */
604 0xEA86, 0x0007, /* eor r0, r6, r7 */
605 0x2D08, /* cmp r5, #8 */
606 0xD1F4, /* bne loop */
608 0xF104, 0x0401, /* add r4, r4, #1 */
610 0x429C, /* cmp r4, r3 */
611 0xD1E9, /* bne nbyte */
614 0x1DB7, 0x04C1 /* CRC32XOR: .word 0x04C11DB7 */
619 if (target_alloc_working_area(target, sizeof(cortex_m3_crc_code), &crc_algorithm) != ERROR_OK)
621 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
624 /* convert flash writing code into a buffer in target endianness */
625 for (i = 0; i < (sizeof(cortex_m3_crc_code)/sizeof(u16)); i++)
626 target_write_u16(target, crc_algorithm->address + i*sizeof(u16), cortex_m3_crc_code[i]);
628 armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
629 armv7m_info.core_mode = ARMV7M_MODE_ANY;
630 armv7m_info.core_state = ARMV7M_STATE_THUMB;
632 init_reg_param(®_params[0], "r0", 32, PARAM_IN_OUT);
633 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
635 buf_set_u32(reg_params[0].value, 0, 32, address);
636 buf_set_u32(reg_params[1].value, 0, 32, count);
638 if ((retval = target->type->run_algorithm(target, 0, NULL, 2, reg_params,
639 crc_algorithm->address, crc_algorithm->address + (sizeof(cortex_m3_crc_code)-6), 20000, &armv7m_info)) != ERROR_OK)
641 ERROR("error executing cortex_m3 crc algorithm");
642 destroy_reg_param(®_params[0]);
643 destroy_reg_param(®_params[1]);
644 target_free_working_area(target, crc_algorithm);
648 *checksum = buf_get_u32(reg_params[0].value, 0, 32);
650 destroy_reg_param(®_params[0]);
651 destroy_reg_param(®_params[1]);
653 target_free_working_area(target, crc_algorithm);