- remove target specific variant and use target->variant member
[openocd.git] / src / target / arm9tdmi.c
blob340c5bebc6e44a40cc072fed7586b6f19495e7dd
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
7 * *
8 * Copyright (C) 2008 by Hongtao Zheng *
9 * hontor@126.com *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
30 #include "arm9tdmi.h"
32 #include "arm7_9_common.h"
33 #include "register.h"
34 #include "target.h"
35 #include "armv4_5.h"
36 #include "embeddedice.h"
37 #include "etm.h"
38 #include "etb.h"
39 #include "log.h"
40 #include "jtag.h"
41 #include "arm_jtag.h"
43 #include <stdlib.h>
44 #include <string.h>
46 #if 0
47 #define _DEBUG_INSTRUCTION_EXECUTION_
48 #endif
50 /* cli handling */
51 int arm9tdmi_register_commands(struct command_context_s *cmd_ctx);
52 int handle_arm9tdmi_catch_vectors_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 /* forward declarations */
55 int arm9tdmi_target_create( struct target_s *target, Jim_Interp *interp );
57 int arm9tdmi_init_target(struct command_context_s *cmd_ctx, struct target_s *target);
58 int arm9tdmi_quit(void);
60 target_type_t arm9tdmi_target =
62 .name = "arm9tdmi",
64 .poll = arm7_9_poll,
65 .arch_state = armv4_5_arch_state,
67 .target_request_data = arm7_9_target_request_data,
69 .halt = arm7_9_halt,
70 .resume = arm7_9_resume,
71 .step = arm7_9_step,
73 .assert_reset = arm7_9_assert_reset,
74 .deassert_reset = arm7_9_deassert_reset,
75 .soft_reset_halt = arm7_9_soft_reset_halt,
77 .get_gdb_reg_list = armv4_5_get_gdb_reg_list,
79 .read_memory = arm7_9_read_memory,
80 .write_memory = arm7_9_write_memory,
81 .bulk_write_memory = arm7_9_bulk_write_memory,
82 .checksum_memory = arm7_9_checksum_memory,
83 .blank_check_memory = arm7_9_blank_check_memory,
85 .run_algorithm = armv4_5_run_algorithm,
87 .add_breakpoint = arm7_9_add_breakpoint,
88 .remove_breakpoint = arm7_9_remove_breakpoint,
89 .add_watchpoint = arm7_9_add_watchpoint,
90 .remove_watchpoint = arm7_9_remove_watchpoint,
92 .register_commands = arm9tdmi_register_commands,
93 .target_create = arm9tdmi_target_create,
94 .init_target = arm9tdmi_init_target,
95 .examine = arm9tdmi_examine,
96 .quit = arm9tdmi_quit
99 arm9tdmi_vector_t arm9tdmi_vectors[] =
101 {"reset", ARM9TDMI_RESET_VECTOR},
102 {"undef", ARM9TDMI_UNDEF_VECTOR},
103 {"swi", ARM9TDMI_SWI_VECTOR},
104 {"pabt", ARM9TDMI_PABT_VECTOR},
105 {"dabt", ARM9TDMI_DABT_VECTOR},
106 {"reserved", ARM9TDMI_RESERVED_VECTOR},
107 {"irq", ARM9TDMI_IRQ_VECTOR},
108 {"fiq", ARM9TDMI_FIQ_VECTOR},
109 {0, 0},
112 int arm9tdmi_examine_debug_reason(target_t *target)
114 int retval = ERROR_OK;
115 /* get pointers to arch-specific information */
116 armv4_5_common_t *armv4_5 = target->arch_info;
117 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
119 /* only check the debug reason if we don't know it already */
120 if ((target->debug_reason != DBG_REASON_DBGRQ)
121 && (target->debug_reason != DBG_REASON_SINGLESTEP))
123 scan_field_t fields[3];
124 u8 databus[4];
125 u8 instructionbus[4];
126 u8 debug_reason;
128 jtag_add_end_state(TAP_DRPAUSE);
130 fields[0].tap = arm7_9->jtag_info.tap;
131 fields[0].num_bits = 32;
132 fields[0].out_value = NULL;
133 fields[0].out_mask = NULL;
134 fields[0].in_value = databus;
135 fields[0].in_check_value = NULL;
136 fields[0].in_check_mask = NULL;
137 fields[0].in_handler = NULL;
138 fields[0].in_handler_priv = NULL;
140 fields[1].tap = arm7_9->jtag_info.tap;
141 fields[1].num_bits = 3;
142 fields[1].out_value = NULL;
143 fields[1].out_mask = NULL;
144 fields[1].in_value = &debug_reason;
145 fields[1].in_check_value = NULL;
146 fields[1].in_check_mask = NULL;
147 fields[1].in_handler = NULL;
148 fields[1].in_handler_priv = NULL;
150 fields[2].tap = arm7_9->jtag_info.tap;
151 fields[2].num_bits = 32;
152 fields[2].out_value = NULL;
153 fields[2].out_mask = NULL;
154 fields[2].in_value = instructionbus;
155 fields[2].in_check_value = NULL;
156 fields[2].in_check_mask = NULL;
157 fields[2].in_handler = NULL;
158 fields[2].in_handler_priv = NULL;
160 if((retval = arm_jtag_scann(&arm7_9->jtag_info, 0x1)) != ERROR_OK)
162 return retval;
164 arm_jtag_set_instr(&arm7_9->jtag_info, arm7_9->jtag_info.intest_instr, NULL);
166 jtag_add_dr_scan(3, fields, TAP_DRPAUSE);
167 if((retval = jtag_execute_queue()) != ERROR_OK)
169 return retval;
172 fields[0].in_value = NULL;
173 fields[0].out_value = databus;
174 fields[1].in_value = NULL;
175 fields[1].out_value = &debug_reason;
176 fields[2].in_value = NULL;
177 fields[2].out_value = instructionbus;
179 jtag_add_dr_scan(3, fields, TAP_DRPAUSE);
181 if (debug_reason & 0x4)
182 if (debug_reason & 0x2)
183 target->debug_reason = DBG_REASON_WPTANDBKPT;
184 else
185 target->debug_reason = DBG_REASON_WATCHPOINT;
186 else
187 target->debug_reason = DBG_REASON_BREAKPOINT;
190 return ERROR_OK;
193 /* put an instruction in the ARM9TDMI pipeline or write the data bus, and optionally read data */
194 int arm9tdmi_clock_out(arm_jtag_t *jtag_info, u32 instr, u32 out, u32 *in, int sysspeed)
196 int retval = ERROR_OK;
197 scan_field_t fields[3];
198 u8 out_buf[4];
199 u8 instr_buf[4];
200 u8 sysspeed_buf = 0x0;
202 /* prepare buffer */
203 buf_set_u32(out_buf, 0, 32, out);
205 buf_set_u32(instr_buf, 0, 32, flip_u32(instr, 32));
207 if (sysspeed)
208 buf_set_u32(&sysspeed_buf, 2, 1, 1);
210 jtag_add_end_state(TAP_DRPAUSE);
211 if((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
213 return retval;
216 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
218 fields[0].tap = jtag_info->tap;
219 fields[0].num_bits = 32;
220 fields[0].out_value = out_buf;
221 fields[0].out_mask = NULL;
222 fields[0].in_value = NULL;
223 if (in)
225 fields[0].in_handler = arm_jtag_buf_to_u32;
226 fields[0].in_handler_priv = in;
228 else
230 fields[0].in_handler = NULL;
231 fields[0].in_handler_priv = NULL;
233 fields[0].in_check_value = NULL;
234 fields[0].in_check_mask = NULL;
236 fields[1].tap = jtag_info->tap;
237 fields[1].num_bits = 3;
238 fields[1].out_value = &sysspeed_buf;
239 fields[1].out_mask = NULL;
240 fields[1].in_value = NULL;
241 fields[1].in_check_value = NULL;
242 fields[1].in_check_mask = NULL;
243 fields[1].in_handler = NULL;
244 fields[1].in_handler_priv = NULL;
246 fields[2].tap = jtag_info->tap;
247 fields[2].num_bits = 32;
248 fields[2].out_value = instr_buf;
249 fields[2].out_mask = NULL;
250 fields[2].in_value = NULL;
251 fields[2].in_check_value = NULL;
252 fields[2].in_check_mask = NULL;
253 fields[2].in_handler = NULL;
254 fields[2].in_handler_priv = NULL;
256 jtag_add_dr_scan(3, fields, -1);
258 jtag_add_runtest(0, -1);
260 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
262 if((retval = jtag_execute_queue()) != ERROR_OK)
264 return retval;
267 if (in)
269 LOG_DEBUG("instr: 0x%8.8x, out: 0x%8.8x, in: 0x%8.8x", instr, out, *in);
271 else
272 LOG_DEBUG("instr: 0x%8.8x, out: 0x%8.8x", instr, out);
274 #endif
276 return ERROR_OK;
279 /* just read data (instruction and data-out = don't care) */
280 int arm9tdmi_clock_data_in(arm_jtag_t *jtag_info, u32 *in)
282 int retval = ERROR_OK;;
283 scan_field_t fields[3];
285 jtag_add_end_state(TAP_DRPAUSE);
286 if((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
288 return retval;
291 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
293 fields[0].tap = jtag_info->tap;
294 fields[0].num_bits = 32;
295 fields[0].out_value = NULL;
296 fields[0].out_mask = NULL;
297 fields[0].in_value = NULL;
298 fields[0].in_handler = arm_jtag_buf_to_u32;
299 fields[0].in_handler_priv = in;
300 fields[0].in_check_value = NULL;
301 fields[0].in_check_mask = NULL;
303 fields[1].tap = jtag_info->tap;
304 fields[1].num_bits = 3;
305 fields[1].out_value = NULL;
306 fields[1].out_mask = NULL;
307 fields[1].in_value = NULL;
308 fields[1].in_handler = NULL;
309 fields[1].in_handler_priv = NULL;
310 fields[1].in_check_value = NULL;
311 fields[1].in_check_mask = NULL;
313 fields[2].tap = jtag_info->tap;
314 fields[2].num_bits = 32;
315 fields[2].out_value = NULL;
316 fields[2].out_mask = NULL;
317 fields[2].in_value = NULL;
318 fields[2].in_check_value = NULL;
319 fields[2].in_check_mask = NULL;
320 fields[2].in_handler = NULL;
321 fields[2].in_handler_priv = NULL;
323 jtag_add_dr_scan(3, fields, -1);
325 jtag_add_runtest(0, -1);
327 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
329 if((retval = jtag_execute_queue()) != ERROR_OK)
331 return retval;
334 if (in)
336 LOG_DEBUG("in: 0x%8.8x", *in);
338 else
340 LOG_ERROR("BUG: called with in == NULL");
343 #endif
345 return ERROR_OK;
348 /* clock the target, and read the databus
349 * the *in pointer points to a buffer where elements of 'size' bytes
350 * are stored in big (be==1) or little (be==0) endianness
352 int arm9tdmi_clock_data_in_endianness(arm_jtag_t *jtag_info, void *in, int size, int be)
354 int retval = ERROR_OK;
355 scan_field_t fields[3];
357 jtag_add_end_state(TAP_DRPAUSE);
358 if((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
360 return retval;
363 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
365 fields[0].tap = jtag_info->tap;
366 fields[0].num_bits = 32;
367 fields[0].out_value = NULL;
368 fields[0].out_mask = NULL;
369 fields[0].in_value = NULL;
370 switch (size)
372 case 4:
373 fields[0].in_handler = (be) ? arm_jtag_buf_to_be32 : arm_jtag_buf_to_le32;
374 break;
375 case 2:
376 fields[0].in_handler = (be) ? arm_jtag_buf_to_be16 : arm_jtag_buf_to_le16;
377 break;
378 case 1:
379 fields[0].in_handler = arm_jtag_buf_to_8;
380 break;
382 fields[0].in_handler_priv = in;
383 fields[0].in_check_value = NULL;
384 fields[0].in_check_mask = NULL;
386 fields[1].tap = jtag_info->tap;
387 fields[1].num_bits = 3;
388 fields[1].out_value = NULL;
389 fields[1].out_mask = NULL;
390 fields[1].in_value = NULL;
391 fields[1].in_handler = NULL;
392 fields[1].in_handler_priv = NULL;
393 fields[1].in_check_value = NULL;
394 fields[1].in_check_mask = NULL;
396 fields[2].tap = jtag_info->tap;
397 fields[2].num_bits = 32;
398 fields[2].out_value = NULL;
399 fields[2].out_mask = NULL;
400 fields[2].in_value = NULL;
401 fields[2].in_check_value = NULL;
402 fields[2].in_check_mask = NULL;
403 fields[2].in_handler = NULL;
404 fields[2].in_handler_priv = NULL;
406 jtag_add_dr_scan(3, fields, -1);
408 jtag_add_runtest(0, -1);
410 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
412 if((retval = jtag_execute_queue()) != ERROR_OK)
414 return retval;
417 if (in)
419 LOG_DEBUG("in: 0x%8.8x", *(u32*)in);
421 else
423 LOG_ERROR("BUG: called with in == NULL");
426 #endif
428 return ERROR_OK;
431 void arm9tdmi_change_to_arm(target_t *target, u32 *r0, u32 *pc)
433 int retval = ERROR_OK;
434 /* get pointers to arch-specific information */
435 armv4_5_common_t *armv4_5 = target->arch_info;
436 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
437 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
439 /* save r0 before using it and put system in ARM state
440 * to allow common handling of ARM and THUMB debugging */
442 /* fetch STR r0, [r0] */
443 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_STR(0, 0), 0, NULL, 0);
444 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
445 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
446 /* STR r0, [r0] in Memory */
447 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, r0, 0);
449 /* MOV r0, r15 fetched, STR in Decode */
450 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_MOV(0, 15), 0, NULL, 0);
451 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
452 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_STR(0, 0), 0, NULL, 0);
453 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
454 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
455 /* nothing fetched, STR r0, [r0] in Memory */
456 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, pc, 0);
458 /* use pc-relative LDR to clear r0[1:0] (for switch to ARM mode) */
459 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_LDR_PCREL(0), 0, NULL, 0);
460 /* LDR in Decode */
461 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
462 /* LDR in Execute */
463 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
464 /* LDR in Memory (to account for interlock) */
465 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
467 /* fetch BX */
468 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_BX(0), 0, NULL, 0);
469 /* NOP fetched, BX in Decode, MOV in Execute */
470 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
471 /* NOP fetched, BX in Execute (1) */
472 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
474 if((retval = jtag_execute_queue()) != ERROR_OK)
476 return;
479 /* fix program counter:
480 * MOV r0, r15 was the 5th instruction (+8)
481 * reading PC in Thumb state gives address of instruction + 4
483 *pc -= 0xc;
486 void arm9tdmi_read_core_regs(target_t *target, u32 mask, u32* core_regs[16])
488 int i;
489 /* get pointers to arch-specific information */
490 armv4_5_common_t *armv4_5 = target->arch_info;
491 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
492 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
494 /* STMIA r0-15, [r0] at debug speed
495 * register values will start to appear on 4th DCLK
497 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
499 /* fetch NOP, STM in DECODE stage */
500 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
501 /* fetch NOP, STM in EXECUTE stage (1st cycle) */
502 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
504 for (i = 0; i <= 15; i++)
506 if (mask & (1 << i))
507 /* nothing fetched, STM in MEMORY (i'th cycle) */
508 arm9tdmi_clock_data_in(jtag_info, core_regs[i]);
512 void arm9tdmi_read_core_regs_target_buffer(target_t *target, u32 mask, void* buffer, int size)
514 int i;
515 /* get pointers to arch-specific information */
516 armv4_5_common_t *armv4_5 = target->arch_info;
517 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
518 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
519 int be = (target->endianness == TARGET_BIG_ENDIAN) ? 1 : 0;
520 u32 *buf_u32 = buffer;
521 u16 *buf_u16 = buffer;
522 u8 *buf_u8 = buffer;
524 /* STMIA r0-15, [r0] at debug speed
525 * register values will start to appear on 4th DCLK
527 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
529 /* fetch NOP, STM in DECODE stage */
530 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
531 /* fetch NOP, STM in EXECUTE stage (1st cycle) */
532 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
534 for (i = 0; i <= 15; i++)
536 if (mask & (1 << i))
537 /* nothing fetched, STM in MEMORY (i'th cycle) */
538 switch (size)
540 case 4:
541 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u32++, 4, be);
542 break;
543 case 2:
544 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u16++, 2, be);
545 break;
546 case 1:
547 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u8++, 1, be);
548 break;
553 void arm9tdmi_read_xpsr(target_t *target, u32 *xpsr, int spsr)
555 /* get pointers to arch-specific information */
556 armv4_5_common_t *armv4_5 = target->arch_info;
557 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
558 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
560 /* MRS r0, cpsr */
561 arm9tdmi_clock_out(jtag_info, ARMV4_5_MRS(0, spsr & 1), 0, NULL, 0);
562 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
563 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
564 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
565 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
567 /* STR r0, [r15] */
568 arm9tdmi_clock_out(jtag_info, ARMV4_5_STR(0, 15), 0, NULL, 0);
569 /* fetch NOP, STR in DECODE stage */
570 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
571 /* fetch NOP, STR in EXECUTE stage (1st cycle) */
572 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
573 /* nothing fetched, STR in MEMORY */
574 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, xpsr, 0);
577 void arm9tdmi_write_xpsr(target_t *target, u32 xpsr, int spsr)
579 /* get pointers to arch-specific information */
580 armv4_5_common_t *armv4_5 = target->arch_info;
581 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
582 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
584 LOG_DEBUG("xpsr: %8.8x, spsr: %i", xpsr, spsr);
586 /* MSR1 fetched */
587 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM(xpsr & 0xff, 0, 1, spsr), 0, NULL, 0);
588 /* MSR2 fetched, MSR1 in DECODE */
589 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff00) >> 8, 0xc, 2, spsr), 0, NULL, 0);
590 /* MSR3 fetched, MSR1 in EXECUTE (1), MSR2 in DECODE */
591 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff0000) >> 16, 0x8, 4, spsr), 0, NULL, 0);
592 /* nothing fetched, MSR1 in EXECUTE (2) */
593 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
594 /* nothing fetched, MSR1 in EXECUTE (3) */
595 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
596 /* MSR4 fetched, MSR2 in EXECUTE (1), MSR3 in DECODE */
597 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff000000) >> 24, 0x4, 8, spsr), 0, NULL, 0);
598 /* nothing fetched, MSR2 in EXECUTE (2) */
599 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
600 /* nothing fetched, MSR2 in EXECUTE (3) */
601 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
602 /* NOP fetched, MSR3 in EXECUTE (1), MSR4 in DECODE */
603 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
604 /* nothing fetched, MSR3 in EXECUTE (2) */
605 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
606 /* nothing fetched, MSR3 in EXECUTE (3) */
607 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
608 /* NOP fetched, MSR4 in EXECUTE (1) */
609 /* last MSR writes flags, which takes only one cycle */
610 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
613 void arm9tdmi_write_xpsr_im8(target_t *target, u8 xpsr_im, int rot, int spsr)
615 /* get pointers to arch-specific information */
616 armv4_5_common_t *armv4_5 = target->arch_info;
617 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
618 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
620 LOG_DEBUG("xpsr_im: %2.2x, rot: %i, spsr: %i", xpsr_im, rot, spsr);
622 /* MSR fetched */
623 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM(xpsr_im, rot, 1, spsr), 0, NULL, 0);
624 /* NOP fetched, MSR in DECODE */
625 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
626 /* NOP fetched, MSR in EXECUTE (1) */
627 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
629 /* rot == 4 writes flags, which takes only one cycle */
630 if (rot != 4)
632 /* nothing fetched, MSR in EXECUTE (2) */
633 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
634 /* nothing fetched, MSR in EXECUTE (3) */
635 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
639 void arm9tdmi_write_core_regs(target_t *target, u32 mask, u32 core_regs[16])
641 int i;
642 /* get pointers to arch-specific information */
643 armv4_5_common_t *armv4_5 = target->arch_info;
644 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
645 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
647 /* LDMIA r0-15, [r0] at debug speed
648 * register values will start to appear on 4th DCLK
650 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
652 /* fetch NOP, LDM in DECODE stage */
653 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
654 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
655 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
657 for (i = 0; i <= 15; i++)
659 if (mask & (1 << i))
660 /* nothing fetched, LDM still in EXECUTE (1+i cycle) */
661 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, core_regs[i], NULL, 0);
663 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
666 void arm9tdmi_load_word_regs(target_t *target, u32 mask)
668 /* get pointers to arch-specific information */
669 armv4_5_common_t *armv4_5 = target->arch_info;
670 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
671 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
673 /* put system-speed load-multiple into the pipeline */
674 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, mask & 0xffff, 0, 1), 0, NULL, 0);
675 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
678 void arm9tdmi_load_hword_reg(target_t *target, int num)
680 /* get pointers to arch-specific information */
681 armv4_5_common_t *armv4_5 = target->arch_info;
682 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
683 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
685 /* put system-speed load half-word into the pipeline */
686 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDRH_IP(num, 0), 0, NULL, 0);
687 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
690 void arm9tdmi_load_byte_reg(target_t *target, int num)
692 /* get pointers to arch-specific information */
693 armv4_5_common_t *armv4_5 = target->arch_info;
694 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
695 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
697 /* put system-speed load byte into the pipeline */
698 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDRB_IP(num, 0), 0, NULL, 0);
699 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
702 void arm9tdmi_store_word_regs(target_t *target, u32 mask)
704 /* get pointers to arch-specific information */
705 armv4_5_common_t *armv4_5 = target->arch_info;
706 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
707 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
709 /* put system-speed store-multiple into the pipeline */
710 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask, 0, 1), 0, NULL, 0);
711 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
714 void arm9tdmi_store_hword_reg(target_t *target, int num)
716 /* get pointers to arch-specific information */
717 armv4_5_common_t *armv4_5 = target->arch_info;
718 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
719 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
721 /* put system-speed store half-word into the pipeline */
722 arm9tdmi_clock_out(jtag_info, ARMV4_5_STRH_IP(num, 0), 0, NULL, 0);
723 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
726 void arm9tdmi_store_byte_reg(target_t *target, int num)
728 /* get pointers to arch-specific information */
729 armv4_5_common_t *armv4_5 = target->arch_info;
730 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
731 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
733 /* put system-speed store byte into the pipeline */
734 arm9tdmi_clock_out(jtag_info, ARMV4_5_STRB_IP(num, 0), 0, NULL, 0);
735 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
738 void arm9tdmi_write_pc(target_t *target, u32 pc)
740 /* get pointers to arch-specific information */
741 armv4_5_common_t *armv4_5 = target->arch_info;
742 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
743 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
745 /* LDMIA r0-15, [r0] at debug speed
746 * register values will start to appear on 4th DCLK
748 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, 0x8000, 0, 0), 0, NULL, 0);
750 /* fetch NOP, LDM in DECODE stage */
751 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
752 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
753 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
754 /* nothing fetched, LDM in EXECUTE stage (2nd cycle) (output data) */
755 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, pc, NULL, 0);
756 /* nothing fetched, LDM in EXECUTE stage (3rd cycle) */
757 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
758 /* fetch NOP, LDM in EXECUTE stage (4th cycle) */
759 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
760 /* fetch NOP, LDM in EXECUTE stage (5th cycle) */
761 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
764 void arm9tdmi_branch_resume(target_t *target)
766 /* get pointers to arch-specific information */
767 armv4_5_common_t *armv4_5 = target->arch_info;
768 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
769 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
771 arm9tdmi_clock_out(jtag_info, ARMV4_5_B(0xfffffc, 0), 0, NULL, 0);
772 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
775 void arm9tdmi_branch_resume_thumb(target_t *target)
777 LOG_DEBUG("-");
779 /* get pointers to arch-specific information */
780 armv4_5_common_t *armv4_5 = target->arch_info;
781 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
782 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
783 reg_t *dbg_stat = &arm7_9->eice_cache->reg_list[EICE_DBG_STAT];
785 /* LDMIA r0-15, [r0] at debug speed
786 * register values will start to appear on 4th DCLK
788 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, 0x1, 0, 0), 0, NULL, 0);
790 /* fetch NOP, LDM in DECODE stage */
791 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
792 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
793 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
794 /* nothing fetched, LDM in EXECUTE stage (2nd cycle) */
795 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, buf_get_u32(armv4_5->core_cache->reg_list[15].value, 0, 32) | 1, NULL, 0);
796 /* nothing fetched, LDM in EXECUTE stage (3rd cycle) */
797 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
799 /* Branch and eXchange */
800 arm9tdmi_clock_out(jtag_info, ARMV4_5_BX(0), 0, NULL, 0);
802 embeddedice_read_reg(dbg_stat);
804 /* fetch NOP, BX in DECODE stage */
805 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
807 embeddedice_read_reg(dbg_stat);
809 /* fetch NOP, BX in EXECUTE stage (1st cycle) */
810 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
812 /* target is now in Thumb state */
813 embeddedice_read_reg(dbg_stat);
815 /* load r0 value, MOV_IM in Decode*/
816 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_LDR_PCREL(0), 0, NULL, 0);
817 /* fetch NOP, LDR in Decode, MOV_IM in Execute */
818 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
819 /* fetch NOP, LDR in Execute */
820 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
821 /* nothing fetched, LDR in EXECUTE stage (2nd cycle) */
822 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, buf_get_u32(armv4_5->core_cache->reg_list[0].value, 0, 32), NULL, 0);
823 /* nothing fetched, LDR in EXECUTE stage (3rd cycle) */
824 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
826 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
827 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
829 embeddedice_read_reg(dbg_stat);
831 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_B(0x7f7), 0, NULL, 1);
832 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
835 void arm9tdmi_enable_single_step(target_t *target, u32 next_pc)
837 /* get pointers to arch-specific information */
838 armv4_5_common_t *armv4_5 = target->arch_info;
839 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
841 if (arm7_9->has_single_step)
843 buf_set_u32(arm7_9->eice_cache->reg_list[EICE_DBG_CTRL].value, 3, 1, 1);
844 embeddedice_store_reg(&arm7_9->eice_cache->reg_list[EICE_DBG_CTRL]);
846 else
848 arm7_9_enable_eice_step(target, next_pc);
852 void arm9tdmi_disable_single_step(target_t *target)
854 /* get pointers to arch-specific information */
855 armv4_5_common_t *armv4_5 = target->arch_info;
856 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
858 if (arm7_9->has_single_step)
860 buf_set_u32(arm7_9->eice_cache->reg_list[EICE_DBG_CTRL].value, 3, 1, 0);
861 embeddedice_store_reg(&arm7_9->eice_cache->reg_list[EICE_DBG_CTRL]);
863 else
865 arm7_9_disable_eice_step(target);
869 void arm9tdmi_build_reg_cache(target_t *target)
871 reg_cache_t **cache_p = register_get_last_cache_p(&target->reg_cache);
872 /* get pointers to arch-specific information */
873 armv4_5_common_t *armv4_5 = target->arch_info;
875 (*cache_p) = armv4_5_build_reg_cache(target, armv4_5);
876 armv4_5->core_cache = (*cache_p);
879 int arm9tdmi_examine(struct target_s *target)
881 /* get pointers to arch-specific information */
882 int retval;
883 armv4_5_common_t *armv4_5 = target->arch_info;
884 arm7_9_common_t *arm7_9 = armv4_5->arch_info;
885 if (!target->type->examined)
887 reg_cache_t **cache_p = register_get_last_cache_p(&target->reg_cache);
888 reg_cache_t *t;
889 /* one extra register (vector catch) */
890 t=embeddedice_build_reg_cache(target, arm7_9);
891 if (t==NULL)
892 return ERROR_FAIL;
893 (*cache_p) = t;
894 arm7_9->eice_cache = (*cache_p);
896 if (arm7_9->etm_ctx)
898 arm_jtag_t *jtag_info = &arm7_9->jtag_info;
899 (*cache_p)->next = etm_build_reg_cache(target, jtag_info, arm7_9->etm_ctx);
900 arm7_9->etm_ctx->reg_cache = (*cache_p)->next;
902 target->type->examined = 1;
904 if ((retval=embeddedice_setup(target))!=ERROR_OK)
905 return retval;
906 if ((retval=arm7_9_setup(target))!=ERROR_OK)
907 return retval;
908 if (arm7_9->etm_ctx)
910 if ((retval=etm_setup(target))!=ERROR_OK)
911 return retval;
913 return ERROR_OK;
916 int arm9tdmi_init_target(struct command_context_s *cmd_ctx, struct target_s *target)
919 arm9tdmi_build_reg_cache(target);
921 return ERROR_OK;
924 int arm9tdmi_quit(void)
926 return ERROR_OK;
929 int arm9tdmi_init_arch_info(target_t *target, arm9tdmi_common_t *arm9tdmi, jtag_tap_t *tap)
931 armv4_5_common_t *armv4_5;
932 arm7_9_common_t *arm7_9;
934 arm7_9 = &arm9tdmi->arm7_9_common;
935 armv4_5 = &arm7_9->armv4_5_common;
937 /* prepare JTAG information for the new target */
938 arm7_9->jtag_info.tap = tap;
939 arm7_9->jtag_info.scann_size = 5;
941 /* register arch-specific functions */
942 arm7_9->examine_debug_reason = arm9tdmi_examine_debug_reason;
943 arm7_9->change_to_arm = arm9tdmi_change_to_arm;
944 arm7_9->read_core_regs = arm9tdmi_read_core_regs;
945 arm7_9->read_core_regs_target_buffer = arm9tdmi_read_core_regs_target_buffer;
946 arm7_9->read_xpsr = arm9tdmi_read_xpsr;
948 arm7_9->write_xpsr = arm9tdmi_write_xpsr;
949 arm7_9->write_xpsr_im8 = arm9tdmi_write_xpsr_im8;
950 arm7_9->write_core_regs = arm9tdmi_write_core_regs;
952 arm7_9->load_word_regs = arm9tdmi_load_word_regs;
953 arm7_9->load_hword_reg = arm9tdmi_load_hword_reg;
954 arm7_9->load_byte_reg = arm9tdmi_load_byte_reg;
956 arm7_9->store_word_regs = arm9tdmi_store_word_regs;
957 arm7_9->store_hword_reg = arm9tdmi_store_hword_reg;
958 arm7_9->store_byte_reg = arm9tdmi_store_byte_reg;
960 arm7_9->write_pc = arm9tdmi_write_pc;
961 arm7_9->branch_resume = arm9tdmi_branch_resume;
962 arm7_9->branch_resume_thumb = arm9tdmi_branch_resume_thumb;
964 arm7_9->enable_single_step = arm9tdmi_enable_single_step;
965 arm7_9->disable_single_step = arm9tdmi_disable_single_step;
967 arm7_9->pre_debug_entry = NULL;
968 arm7_9->post_debug_entry = NULL;
970 arm7_9->pre_restore_context = NULL;
971 arm7_9->post_restore_context = NULL;
973 /* initialize arch-specific breakpoint handling */
974 arm7_9->arm_bkpt = 0xdeeedeee;
975 arm7_9->thumb_bkpt = 0xdeee;
977 arm7_9->dbgreq_adjust_pc = 3;
978 arm7_9->arch_info = arm9tdmi;
980 arm9tdmi->common_magic = ARM9TDMI_COMMON_MAGIC;
981 arm9tdmi->arch_info = NULL;
983 arm7_9_init_arch_info(target, arm7_9);
985 /* override use of DBGRQ, this is safe on ARM9TDMI */
986 arm7_9->use_dbgrq = 1;
988 /* all ARM9s have the vector catch register */
989 arm7_9->has_vector_catch = 1;
991 return ERROR_OK;
994 int arm9tdmi_get_arch_pointers(target_t *target, armv4_5_common_t **armv4_5_p, arm7_9_common_t **arm7_9_p, arm9tdmi_common_t **arm9tdmi_p)
996 armv4_5_common_t *armv4_5 = target->arch_info;
997 arm7_9_common_t *arm7_9;
998 arm9tdmi_common_t *arm9tdmi;
1000 if (armv4_5->common_magic != ARMV4_5_COMMON_MAGIC)
1002 return -1;
1005 arm7_9 = armv4_5->arch_info;
1006 if (arm7_9->common_magic != ARM7_9_COMMON_MAGIC)
1008 return -1;
1011 arm9tdmi = arm7_9->arch_info;
1012 if (arm9tdmi->common_magic != ARM9TDMI_COMMON_MAGIC)
1014 return -1;
1017 *armv4_5_p = armv4_5;
1018 *arm7_9_p = arm7_9;
1019 *arm9tdmi_p = arm9tdmi;
1021 return ERROR_OK;
1024 int arm9tdmi_target_create(struct target_s *target, Jim_Interp *interp)
1026 arm9tdmi_common_t *arm9tdmi = calloc(1,sizeof(arm9tdmi_common_t));
1028 arm9tdmi_init_arch_info(target, arm9tdmi, target->tap);
1030 return ERROR_OK;
1033 int arm9tdmi_register_commands(struct command_context_s *cmd_ctx)
1035 int retval;
1036 command_t *arm9tdmi_cmd;
1038 retval = arm7_9_register_commands(cmd_ctx);
1039 arm9tdmi_cmd = register_command(cmd_ctx, NULL, "arm9tdmi", NULL, COMMAND_ANY, "arm9tdmi specific commands");
1040 register_command(cmd_ctx, arm9tdmi_cmd, "vector_catch", handle_arm9tdmi_catch_vectors_command, COMMAND_EXEC, "catch arm920t vectors ['all'|'none'|'<vec1 vec2 ...>']");
1042 return retval;
1045 int handle_arm9tdmi_catch_vectors_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1047 target_t *target = get_current_target(cmd_ctx);
1048 armv4_5_common_t *armv4_5;
1049 arm7_9_common_t *arm7_9;
1050 arm9tdmi_common_t *arm9tdmi;
1051 reg_t *vector_catch;
1052 u32 vector_catch_value;
1053 int i, j;
1055 if (arm9tdmi_get_arch_pointers(target, &armv4_5, &arm7_9, &arm9tdmi) != ERROR_OK)
1057 command_print(cmd_ctx, "current target isn't an ARM9TDMI based target");
1058 return ERROR_OK;
1061 vector_catch = &arm7_9->eice_cache->reg_list[EICE_VEC_CATCH];
1063 /* read the vector catch register if necessary */
1064 if (!vector_catch->valid)
1065 embeddedice_read_reg(vector_catch);
1067 /* get the current setting */
1068 vector_catch_value = buf_get_u32(vector_catch->value, 0, 32);
1070 if (argc > 0)
1072 vector_catch_value = 0x0;
1073 if (strcmp(args[0], "all") == 0)
1075 vector_catch_value = 0xdf;
1077 else if (strcmp(args[0], "none") == 0)
1079 /* do nothing */
1081 else
1083 for (i = 0; i < argc; i++)
1085 /* go through list of vectors */
1086 for(j = 0; arm9tdmi_vectors[j].name; j++)
1088 if (strcmp(args[i], arm9tdmi_vectors[j].name) == 0)
1090 vector_catch_value |= arm9tdmi_vectors[j].value;
1091 break;
1095 /* complain if vector wasn't found */
1096 if (!arm9tdmi_vectors[j].name)
1098 command_print(cmd_ctx, "vector '%s' not found, leaving current setting unchanged", args[i]);
1100 /* reread current setting */
1101 vector_catch_value = buf_get_u32(vector_catch->value, 0, 32);
1103 break;
1108 /* store new settings */
1109 buf_set_u32(vector_catch->value, 0, 32, vector_catch_value);
1110 embeddedice_store_reg(vector_catch);
1113 /* output current settings (skip RESERVED vector) */
1114 for (i = 0; i < 8; i++)
1116 if (i != 5)
1118 command_print(cmd_ctx, "%s: %s", arm9tdmi_vectors[i].name,
1119 (vector_catch_value & (1 << i)) ? "catch" : "don't catch");
1123 return ERROR_OK;