ARM7/ARM9: use shared examine() method
[openocd/ztw.git] / src / target / arm9tdmi.c
blob44a978ad58f5037cbc3cc6805c12e06451548f0f
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"
31 #include "target_type.h"
35 * NOTE: this holds code that's used with multiple ARM9 processors:
36 * - ARM9TDMI (ARMv4T) ... in ARM920, ARM922, and ARM940 cores
37 * - ARM9E-S (ARMv5TE) ... in ARM946, ARM966, and ARM968 cores
38 * - ARM9EJS (ARMv5TEJ) ... in ARM926 core
40 * In short, the file name is a misnomer ... it is NOT specific to
41 * that first generation ARM9 processor, or cores using it.
44 #if 0
45 #define _DEBUG_INSTRUCTION_EXECUTION_
46 #endif
48 static const struct arm9tdmi_vector arm9tdmi_vectors[] =
50 {"reset", ARM9TDMI_RESET_VECTOR},
51 {"undef", ARM9TDMI_UNDEF_VECTOR},
52 {"swi", ARM9TDMI_SWI_VECTOR},
53 {"pabt", ARM9TDMI_PABT_VECTOR},
54 {"dabt", ARM9TDMI_DABT_VECTOR},
55 {"irq", ARM9TDMI_IRQ_VECTOR},
56 {"fiq", ARM9TDMI_FIQ_VECTOR},
57 {0, 0},
60 int arm9tdmi_examine_debug_reason(struct target *target)
62 int retval = ERROR_OK;
63 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
65 /* only check the debug reason if we don't know it already */
66 if ((target->debug_reason != DBG_REASON_DBGRQ)
67 && (target->debug_reason != DBG_REASON_SINGLESTEP))
69 struct scan_field fields[3];
70 uint8_t databus[4];
71 uint8_t instructionbus[4];
72 uint8_t debug_reason;
74 jtag_set_end_state(TAP_DRPAUSE);
76 fields[0].tap = arm7_9->jtag_info.tap;
77 fields[0].num_bits = 32;
78 fields[0].out_value = NULL;
79 fields[0].in_value = databus;
81 fields[1].tap = arm7_9->jtag_info.tap;
82 fields[1].num_bits = 3;
83 fields[1].out_value = NULL;
84 fields[1].in_value = &debug_reason;
86 fields[2].tap = arm7_9->jtag_info.tap;
87 fields[2].num_bits = 32;
88 fields[2].out_value = NULL;
89 fields[2].in_value = instructionbus;
91 if ((retval = arm_jtag_scann(&arm7_9->jtag_info, 0x1)) != ERROR_OK)
93 return retval;
95 arm_jtag_set_instr(&arm7_9->jtag_info, arm7_9->jtag_info.intest_instr, NULL);
97 jtag_add_dr_scan(3, fields, jtag_set_end_state(TAP_DRPAUSE));
98 if ((retval = jtag_execute_queue()) != ERROR_OK)
100 return retval;
103 fields[0].in_value = NULL;
104 fields[0].out_value = databus;
105 fields[1].in_value = NULL;
106 fields[1].out_value = &debug_reason;
107 fields[2].in_value = NULL;
108 fields[2].out_value = instructionbus;
110 jtag_add_dr_scan(3, fields, jtag_set_end_state(TAP_DRPAUSE));
112 if (debug_reason & 0x4)
113 if (debug_reason & 0x2)
114 target->debug_reason = DBG_REASON_WPTANDBKPT;
115 else
116 target->debug_reason = DBG_REASON_WATCHPOINT;
117 else
118 target->debug_reason = DBG_REASON_BREAKPOINT;
121 return ERROR_OK;
124 /* put an instruction in the ARM9TDMI pipeline or write the data bus,
125 * and optionally read data
127 int arm9tdmi_clock_out(struct arm_jtag *jtag_info, uint32_t instr,
128 uint32_t out, uint32_t *in, int sysspeed)
130 int retval = ERROR_OK;
131 struct scan_field fields[3];
132 uint8_t out_buf[4];
133 uint8_t instr_buf[4];
134 uint8_t sysspeed_buf = 0x0;
136 /* prepare buffer */
137 buf_set_u32(out_buf, 0, 32, out);
139 buf_set_u32(instr_buf, 0, 32, flip_u32(instr, 32));
141 if (sysspeed)
142 buf_set_u32(&sysspeed_buf, 2, 1, 1);
144 jtag_set_end_state(TAP_DRPAUSE);
145 if ((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
147 return retval;
150 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
152 fields[0].tap = jtag_info->tap;
153 fields[0].num_bits = 32;
154 fields[0].out_value = out_buf;
155 fields[0].in_value = NULL;
157 fields[1].tap = jtag_info->tap;
158 fields[1].num_bits = 3;
159 fields[1].out_value = &sysspeed_buf;
160 fields[1].in_value = NULL;
162 fields[2].tap = jtag_info->tap;
163 fields[2].num_bits = 32;
164 fields[2].out_value = instr_buf;
165 fields[2].in_value = NULL;
167 if (in)
169 fields[0].in_value = (uint8_t *)in;
170 jtag_add_dr_scan(3, fields, jtag_get_end_state());
172 jtag_add_callback(arm_le_to_h_u32, (jtag_callback_data_t)in);
174 else
176 jtag_add_dr_scan(3, fields, jtag_get_end_state());
179 jtag_add_runtest(0, jtag_get_end_state());
181 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
183 if ((retval = jtag_execute_queue()) != ERROR_OK)
185 return retval;
188 if (in)
190 LOG_DEBUG("instr: 0x%8.8x, out: 0x%8.8x, in: 0x%8.8x", instr, out, *in);
192 else
193 LOG_DEBUG("instr: 0x%8.8x, out: 0x%8.8x", instr, out);
195 #endif
197 return ERROR_OK;
200 /* just read data (instruction and data-out = don't care) */
201 int arm9tdmi_clock_data_in(struct arm_jtag *jtag_info, uint32_t *in)
203 int retval = ERROR_OK;;
204 struct scan_field fields[3];
206 jtag_set_end_state(TAP_DRPAUSE);
207 if ((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
209 return retval;
212 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
214 fields[0].tap = jtag_info->tap;
215 fields[0].num_bits = 32;
216 fields[0].out_value = NULL;
217 fields[0].in_value = (uint8_t *)in;
219 fields[1].tap = jtag_info->tap;
220 fields[1].num_bits = 3;
221 fields[1].out_value = NULL;
222 fields[1].in_value = NULL;
224 fields[2].tap = jtag_info->tap;
225 fields[2].num_bits = 32;
226 fields[2].out_value = NULL;
227 fields[2].in_value = NULL;
229 jtag_add_dr_scan(3, fields, jtag_get_end_state());
231 jtag_add_callback(arm_le_to_h_u32, (jtag_callback_data_t)in);
233 jtag_add_runtest(0, jtag_get_end_state());
235 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
237 if ((retval = jtag_execute_queue()) != ERROR_OK)
239 return retval;
242 if (in)
244 LOG_DEBUG("in: 0x%8.8x", *in);
246 else
248 LOG_ERROR("BUG: called with in == NULL");
251 #endif
253 return ERROR_OK;
256 extern void arm_endianness(uint8_t *tmp, void *in, int size, int be, int flip);
258 static int arm9endianness(jtag_callback_data_t arg,
259 jtag_callback_data_t size, jtag_callback_data_t be,
260 jtag_callback_data_t captured)
262 uint8_t *in = (uint8_t *)arg;
264 arm_endianness((uint8_t *)captured, in, (int)size, (int)be, 0);
265 return ERROR_OK;
268 /* clock the target, and read the databus
269 * the *in pointer points to a buffer where elements of 'size' bytes
270 * are stored in big (be == 1) or little (be == 0) endianness
272 int arm9tdmi_clock_data_in_endianness(struct arm_jtag *jtag_info,
273 void *in, int size, int be)
275 int retval = ERROR_OK;
276 struct scan_field fields[3];
278 jtag_set_end_state(TAP_DRPAUSE);
279 if ((retval = arm_jtag_scann(jtag_info, 0x1)) != ERROR_OK)
281 return retval;
284 arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
286 fields[0].tap = jtag_info->tap;
287 fields[0].num_bits = 32;
288 fields[0].out_value = NULL;
289 jtag_alloc_in_value32(&fields[0]);
291 fields[1].tap = jtag_info->tap;
292 fields[1].num_bits = 3;
293 fields[1].out_value = NULL;
294 fields[1].in_value = NULL;
296 fields[2].tap = jtag_info->tap;
297 fields[2].num_bits = 32;
298 fields[2].out_value = NULL;
299 fields[2].in_value = NULL;
301 jtag_add_dr_scan(3, fields, jtag_get_end_state());
303 jtag_add_callback4(arm9endianness, (jtag_callback_data_t)in, (jtag_callback_data_t)size, (jtag_callback_data_t)be, (jtag_callback_data_t)fields[0].in_value);
305 jtag_add_runtest(0, jtag_get_end_state());
307 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
309 if ((retval = jtag_execute_queue()) != ERROR_OK)
311 return retval;
314 if (in)
316 LOG_DEBUG("in: 0x%8.8x", *(uint32_t*)in);
318 else
320 LOG_ERROR("BUG: called with in == NULL");
323 #endif
325 return ERROR_OK;
328 static void arm9tdmi_change_to_arm(struct target *target,
329 uint32_t *r0, uint32_t *pc)
331 int retval = ERROR_OK;
332 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
333 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
335 /* save r0 before using it and put system in ARM state
336 * to allow common handling of ARM and THUMB debugging */
338 /* fetch STR r0, [r0] */
339 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_STR(0, 0), 0, NULL, 0);
340 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
341 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
342 /* STR r0, [r0] in Memory */
343 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, r0, 0);
345 /* MOV r0, r15 fetched, STR in Decode */
346 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_MOV(0, 15), 0, NULL, 0);
347 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
348 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_STR(0, 0), 0, NULL, 0);
349 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
350 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
351 /* nothing fetched, STR r0, [r0] in Memory */
352 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, pc, 0);
354 /* use pc-relative LDR to clear r0[1:0] (for switch to ARM mode) */
355 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_LDR_PCREL(0), 0, NULL, 0);
356 /* LDR in Decode */
357 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
358 /* LDR in Execute */
359 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
360 /* LDR in Memory (to account for interlock) */
361 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
363 /* fetch BX */
364 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_BX(0), 0, NULL, 0);
365 /* NOP fetched, BX in Decode, MOV in Execute */
366 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
367 /* NOP fetched, BX in Execute (1) */
368 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
370 if ((retval = jtag_execute_queue()) != ERROR_OK)
372 return;
375 /* fix program counter:
376 * MOV r0, r15 was the 5th instruction (+8)
377 * reading PC in Thumb state gives address of instruction + 4
379 *pc -= 0xc;
382 void arm9tdmi_read_core_regs(struct target *target,
383 uint32_t mask, uint32_t* core_regs[16])
385 int i;
386 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
387 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
389 /* STMIA r0-15, [r0] at debug speed
390 * register values will start to appear on 4th DCLK
392 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
394 /* fetch NOP, STM in DECODE stage */
395 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
396 /* fetch NOP, STM in EXECUTE stage (1st cycle) */
397 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
399 for (i = 0; i <= 15; i++)
401 if (mask & (1 << i))
402 /* nothing fetched, STM in MEMORY (i'th cycle) */
403 arm9tdmi_clock_data_in(jtag_info, core_regs[i]);
407 static void arm9tdmi_read_core_regs_target_buffer(struct target *target,
408 uint32_t mask, void* buffer, int size)
410 int i;
411 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
412 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
413 int be = (target->endianness == TARGET_BIG_ENDIAN) ? 1 : 0;
414 uint32_t *buf_u32 = buffer;
415 uint16_t *buf_u16 = buffer;
416 uint8_t *buf_u8 = buffer;
418 /* STMIA r0-15, [r0] at debug speed
419 * register values will start to appear on 4th DCLK
421 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
423 /* fetch NOP, STM in DECODE stage */
424 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
425 /* fetch NOP, STM in EXECUTE stage (1st cycle) */
426 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
428 for (i = 0; i <= 15; i++)
430 if (mask & (1 << i))
431 /* nothing fetched, STM in MEMORY (i'th cycle) */
432 switch (size)
434 case 4:
435 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u32++, 4, be);
436 break;
437 case 2:
438 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u16++, 2, be);
439 break;
440 case 1:
441 arm9tdmi_clock_data_in_endianness(jtag_info, buf_u8++, 1, be);
442 break;
447 static void arm9tdmi_read_xpsr(struct target *target, uint32_t *xpsr, int spsr)
449 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
450 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
452 /* MRS r0, cpsr */
453 arm9tdmi_clock_out(jtag_info, ARMV4_5_MRS(0, spsr & 1), 0, NULL, 0);
454 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
455 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
456 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
457 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
459 /* STR r0, [r15] */
460 arm9tdmi_clock_out(jtag_info, ARMV4_5_STR(0, 15), 0, NULL, 0);
461 /* fetch NOP, STR in DECODE stage */
462 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
463 /* fetch NOP, STR in EXECUTE stage (1st cycle) */
464 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
465 /* nothing fetched, STR in MEMORY */
466 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, xpsr, 0);
469 static void arm9tdmi_write_xpsr(struct target *target, uint32_t xpsr, int spsr)
471 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
472 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
474 LOG_DEBUG("xpsr: %8.8" PRIx32 ", spsr: %i", xpsr, spsr);
476 /* MSR1 fetched */
477 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM(xpsr & 0xff, 0, 1, spsr), 0, NULL, 0);
478 /* MSR2 fetched, MSR1 in DECODE */
479 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff00) >> 8, 0xc, 2, spsr), 0, NULL, 0);
480 /* MSR3 fetched, MSR1 in EXECUTE (1), MSR2 in DECODE */
481 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff0000) >> 16, 0x8, 4, spsr), 0, NULL, 0);
482 /* nothing fetched, MSR1 in EXECUTE (2) */
483 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
484 /* nothing fetched, MSR1 in EXECUTE (3) */
485 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
486 /* MSR4 fetched, MSR2 in EXECUTE (1), MSR3 in DECODE */
487 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM((xpsr & 0xff000000) >> 24, 0x4, 8, spsr), 0, NULL, 0);
488 /* nothing fetched, MSR2 in EXECUTE (2) */
489 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
490 /* nothing fetched, MSR2 in EXECUTE (3) */
491 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
492 /* NOP fetched, MSR3 in EXECUTE (1), MSR4 in DECODE */
493 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
494 /* nothing fetched, MSR3 in EXECUTE (2) */
495 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
496 /* nothing fetched, MSR3 in EXECUTE (3) */
497 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
498 /* NOP fetched, MSR4 in EXECUTE (1) */
499 /* last MSR writes flags, which takes only one cycle */
500 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
503 static void arm9tdmi_write_xpsr_im8(struct target *target,
504 uint8_t xpsr_im, int rot, int spsr)
506 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
507 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
509 LOG_DEBUG("xpsr_im: %2.2x, rot: %i, spsr: %i", xpsr_im, rot, spsr);
511 /* MSR fetched */
512 arm9tdmi_clock_out(jtag_info, ARMV4_5_MSR_IM(xpsr_im, rot, 1, spsr), 0, NULL, 0);
513 /* NOP fetched, MSR in DECODE */
514 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
515 /* NOP fetched, MSR in EXECUTE (1) */
516 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
518 /* rot == 4 writes flags, which takes only one cycle */
519 if (rot != 4)
521 /* nothing fetched, MSR in EXECUTE (2) */
522 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
523 /* nothing fetched, MSR in EXECUTE (3) */
524 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
528 void arm9tdmi_write_core_regs(struct target *target,
529 uint32_t mask, uint32_t core_regs[16])
531 int i;
532 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
533 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
535 /* LDMIA r0-15, [r0] at debug speed
536 * register values will start to appear on 4th DCLK
538 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, mask & 0xffff, 0, 0), 0, NULL, 0);
540 /* fetch NOP, LDM in DECODE stage */
541 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
542 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
543 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
545 for (i = 0; i <= 15; i++)
547 if (mask & (1 << i))
548 /* nothing fetched, LDM still in EXECUTE (1 + i cycle) */
549 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, core_regs[i], NULL, 0);
551 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
554 void arm9tdmi_load_word_regs(struct target *target, uint32_t mask)
556 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
557 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
559 /* put system-speed load-multiple into the pipeline */
560 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, mask & 0xffff, 0, 1), 0, NULL, 0);
561 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
564 void arm9tdmi_load_hword_reg(struct target *target, int num)
566 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
567 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
569 /* put system-speed load half-word into the pipeline */
570 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDRH_IP(num, 0), 0, NULL, 0);
571 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
574 void arm9tdmi_load_byte_reg(struct target *target, int num)
576 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
577 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
579 /* put system-speed load byte into the pipeline */
580 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDRB_IP(num, 0), 0, NULL, 0);
581 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
584 void arm9tdmi_store_word_regs(struct target *target, uint32_t mask)
586 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
587 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
589 /* put system-speed store-multiple into the pipeline */
590 arm9tdmi_clock_out(jtag_info, ARMV4_5_STMIA(0, mask, 0, 1), 0, NULL, 0);
591 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
594 void arm9tdmi_store_hword_reg(struct target *target, int num)
596 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
597 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
599 /* put system-speed store half-word into the pipeline */
600 arm9tdmi_clock_out(jtag_info, ARMV4_5_STRH_IP(num, 0), 0, NULL, 0);
601 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
604 void arm9tdmi_store_byte_reg(struct target *target, int num)
606 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
607 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
609 /* put system-speed store byte into the pipeline */
610 arm9tdmi_clock_out(jtag_info, ARMV4_5_STRB_IP(num, 0), 0, NULL, 0);
611 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
614 static void arm9tdmi_write_pc(struct target *target, uint32_t pc)
616 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
617 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
619 /* LDMIA r0-15, [r0] at debug speed
620 * register values will start to appear on 4th DCLK
622 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, 0x8000, 0, 0), 0, NULL, 0);
624 /* fetch NOP, LDM in DECODE stage */
625 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
626 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
627 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
628 /* nothing fetched, LDM in EXECUTE stage (2nd cycle) (output data) */
629 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, pc, NULL, 0);
630 /* nothing fetched, LDM in EXECUTE stage (3rd cycle) */
631 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
632 /* fetch NOP, LDM in EXECUTE stage (4th cycle) */
633 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
634 /* fetch NOP, LDM in EXECUTE stage (5th cycle) */
635 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
638 void arm9tdmi_branch_resume(struct target *target)
640 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
641 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
643 arm9tdmi_clock_out(jtag_info, ARMV4_5_B(0xfffffc, 0), 0, NULL, 0);
644 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 1);
647 static void arm9tdmi_branch_resume_thumb(struct target *target)
649 LOG_DEBUG("-");
651 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
652 struct armv4_5_common_s *armv4_5 = &arm7_9->armv4_5_common;
653 struct arm_jtag *jtag_info = &arm7_9->jtag_info;
654 struct reg *dbg_stat = &arm7_9->eice_cache->reg_list[EICE_DBG_STAT];
656 /* LDMIA r0-15, [r0] at debug speed
657 * register values will start to appear on 4th DCLK
659 arm9tdmi_clock_out(jtag_info, ARMV4_5_LDMIA(0, 0x1, 0, 0), 0, NULL, 0);
661 /* fetch NOP, LDM in DECODE stage */
662 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
663 /* fetch NOP, LDM in EXECUTE stage (1st cycle) */
664 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
665 /* nothing fetched, LDM in EXECUTE stage (2nd cycle) */
666 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, buf_get_u32(armv4_5->core_cache->reg_list[15].value, 0, 32) | 1, NULL, 0);
667 /* nothing fetched, LDM in EXECUTE stage (3rd cycle) */
668 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
670 /* Branch and eXchange */
671 arm9tdmi_clock_out(jtag_info, ARMV4_5_BX(0), 0, NULL, 0);
673 embeddedice_read_reg(dbg_stat);
675 /* fetch NOP, BX in DECODE stage */
676 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
678 embeddedice_read_reg(dbg_stat);
680 /* fetch NOP, BX in EXECUTE stage (1st cycle) */
681 arm9tdmi_clock_out(jtag_info, ARMV4_5_NOP, 0, NULL, 0);
683 /* target is now in Thumb state */
684 embeddedice_read_reg(dbg_stat);
686 /* load r0 value, MOV_IM in Decode*/
687 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_LDR_PCREL(0), 0, NULL, 0);
688 /* fetch NOP, LDR in Decode, MOV_IM in Execute */
689 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
690 /* fetch NOP, LDR in Execute */
691 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
692 /* nothing fetched, LDR in EXECUTE stage (2nd cycle) */
693 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, buf_get_u32(armv4_5->core_cache->reg_list[0].value, 0, 32), NULL, 0);
694 /* nothing fetched, LDR in EXECUTE stage (3rd cycle) */
695 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
697 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
698 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
700 embeddedice_read_reg(dbg_stat);
702 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_B(0x7f7), 0, NULL, 1);
703 arm9tdmi_clock_out(jtag_info, ARMV4_5_T_NOP, 0, NULL, 0);
706 void arm9tdmi_enable_single_step(struct target *target, uint32_t next_pc)
708 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
710 if (arm7_9->has_single_step)
712 buf_set_u32(arm7_9->eice_cache->reg_list[EICE_DBG_CTRL].value, 3, 1, 1);
713 embeddedice_store_reg(&arm7_9->eice_cache->reg_list[EICE_DBG_CTRL]);
715 else
717 arm7_9_enable_eice_step(target, next_pc);
721 void arm9tdmi_disable_single_step(struct target *target)
723 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
725 if (arm7_9->has_single_step)
727 buf_set_u32(arm7_9->eice_cache->reg_list[EICE_DBG_CTRL].value, 3, 1, 0);
728 embeddedice_store_reg(&arm7_9->eice_cache->reg_list[EICE_DBG_CTRL]);
730 else
732 arm7_9_disable_eice_step(target);
736 static void arm9tdmi_build_reg_cache(struct target *target)
738 struct reg_cache **cache_p = register_get_last_cache_p(&target->reg_cache);
739 struct armv4_5_common_s *armv4_5 = target_to_armv4_5(target);
741 (*cache_p) = armv4_5_build_reg_cache(target, armv4_5);
742 armv4_5->core_cache = (*cache_p);
745 int arm9tdmi_init_target(struct command_context *cmd_ctx,
746 struct target *target)
748 arm9tdmi_build_reg_cache(target);
749 return ERROR_OK;
752 int arm9tdmi_init_arch_info(struct target *target, struct arm9tdmi_common *arm9tdmi, struct jtag_tap *tap)
754 struct arm *armv4_5;
755 struct arm7_9_common *arm7_9;
757 arm7_9 = &arm9tdmi->arm7_9_common;
758 armv4_5 = &arm7_9->armv4_5_common;
760 /* prepare JTAG information for the new target */
761 arm7_9->jtag_info.tap = tap;
762 arm7_9->jtag_info.scann_size = 5;
764 /* register arch-specific functions */
765 arm7_9->examine_debug_reason = arm9tdmi_examine_debug_reason;
766 arm7_9->change_to_arm = arm9tdmi_change_to_arm;
767 arm7_9->read_core_regs = arm9tdmi_read_core_regs;
768 arm7_9->read_core_regs_target_buffer = arm9tdmi_read_core_regs_target_buffer;
769 arm7_9->read_xpsr = arm9tdmi_read_xpsr;
771 arm7_9->write_xpsr = arm9tdmi_write_xpsr;
772 arm7_9->write_xpsr_im8 = arm9tdmi_write_xpsr_im8;
773 arm7_9->write_core_regs = arm9tdmi_write_core_regs;
775 arm7_9->load_word_regs = arm9tdmi_load_word_regs;
776 arm7_9->load_hword_reg = arm9tdmi_load_hword_reg;
777 arm7_9->load_byte_reg = arm9tdmi_load_byte_reg;
779 arm7_9->store_word_regs = arm9tdmi_store_word_regs;
780 arm7_9->store_hword_reg = arm9tdmi_store_hword_reg;
781 arm7_9->store_byte_reg = arm9tdmi_store_byte_reg;
783 arm7_9->write_pc = arm9tdmi_write_pc;
784 arm7_9->branch_resume = arm9tdmi_branch_resume;
785 arm7_9->branch_resume_thumb = arm9tdmi_branch_resume_thumb;
787 arm7_9->enable_single_step = arm9tdmi_enable_single_step;
788 arm7_9->disable_single_step = arm9tdmi_disable_single_step;
790 arm7_9->post_debug_entry = NULL;
792 arm7_9->pre_restore_context = NULL;
793 arm7_9->post_restore_context = NULL;
795 /* initialize arch-specific breakpoint handling */
796 arm7_9->arm_bkpt = 0xdeeedeee;
797 arm7_9->thumb_bkpt = 0xdeee;
799 arm7_9->dbgreq_adjust_pc = 3;
801 arm7_9_init_arch_info(target, arm7_9);
803 /* override use of DBGRQ, this is safe on ARM9TDMI */
804 arm7_9->use_dbgrq = 1;
806 /* all ARM9s have the vector catch register */
807 arm7_9->has_vector_catch = 1;
809 return ERROR_OK;
812 static int arm9tdmi_target_create(struct target *target, Jim_Interp *interp)
814 struct arm9tdmi_common *arm9tdmi = calloc(1,sizeof(struct arm9tdmi_common));
816 arm9tdmi_init_arch_info(target, arm9tdmi, target->tap);
817 arm9tdmi->arm7_9_common.armv4_5_common.is_armv4 = true;
819 return ERROR_OK;
822 COMMAND_HANDLER(handle_arm9tdmi_catch_vectors_command)
824 struct target *target = get_current_target(cmd_ctx);
825 struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
826 struct reg *vector_catch;
827 uint32_t vector_catch_value;
829 /* it's uncommon, but some ARM7 chips can support this */
830 if (arm7_9->common_magic != ARM7_9_COMMON_MAGIC
831 || !arm7_9->has_vector_catch) {
832 command_print(cmd_ctx, "target doesn't have EmbeddedICE "
833 "with vector_catch");
834 return ERROR_TARGET_INVALID;
837 vector_catch = &arm7_9->eice_cache->reg_list[EICE_VEC_CATCH];
839 /* read the vector catch register if necessary */
840 if (!vector_catch->valid)
841 embeddedice_read_reg(vector_catch);
843 /* get the current setting */
844 vector_catch_value = buf_get_u32(vector_catch->value, 0, 8);
846 if (argc > 0)
848 vector_catch_value = 0x0;
849 if (strcmp(args[0], "all") == 0)
851 vector_catch_value = 0xdf;
853 else if (strcmp(args[0], "none") == 0)
855 /* do nothing */
857 else
859 for (unsigned i = 0; i < argc; i++)
861 /* go through list of vectors */
862 unsigned j;
863 for (j = 0; arm9tdmi_vectors[j].name; j++)
865 if (strcmp(args[i], arm9tdmi_vectors[j].name) == 0)
867 vector_catch_value |= arm9tdmi_vectors[j].value;
868 break;
872 /* complain if vector wasn't found */
873 if (!arm9tdmi_vectors[j].name)
875 command_print(cmd_ctx, "vector '%s' not found, leaving current setting unchanged", args[i]);
877 /* reread current setting */
878 vector_catch_value = buf_get_u32(
879 vector_catch->value,
880 0, 8);
882 break;
887 /* store new settings */
888 buf_set_u32(vector_catch->value, 0, 8, vector_catch_value);
889 embeddedice_store_reg(vector_catch);
892 /* output current settings */
893 for (unsigned i = 0; arm9tdmi_vectors[i].name; i++) {
894 command_print(cmd_ctx, "%s: %s", arm9tdmi_vectors[i].name,
895 (vector_catch_value & arm9tdmi_vectors[i].value)
896 ? "catch" : "don't catch");
899 return ERROR_OK;
902 int arm9tdmi_register_commands(struct command_context *cmd_ctx)
904 int retval;
905 struct command *arm9tdmi_cmd;
907 retval = arm7_9_register_commands(cmd_ctx);
908 arm9tdmi_cmd = register_command(cmd_ctx, NULL, "arm9",
909 NULL, COMMAND_ANY,
910 "arm9 specific commands");
911 register_command(cmd_ctx, arm9tdmi_cmd, "vector_catch",
912 handle_arm9tdmi_catch_vectors_command, COMMAND_EXEC,
913 "arm9 vector_catch [all|none|reset|undef|swi|pabt|dabt|irq|fiq] ...");
915 return retval;
918 /** Holds methods for ARM9TDMI targets. */
919 struct target_type arm9tdmi_target =
921 .name = "arm9tdmi",
923 .poll = arm7_9_poll,
924 .arch_state = armv4_5_arch_state,
926 .target_request_data = arm7_9_target_request_data,
928 .halt = arm7_9_halt,
929 .resume = arm7_9_resume,
930 .step = arm7_9_step,
932 .assert_reset = arm7_9_assert_reset,
933 .deassert_reset = arm7_9_deassert_reset,
934 .soft_reset_halt = arm7_9_soft_reset_halt,
936 .get_gdb_reg_list = armv4_5_get_gdb_reg_list,
938 .read_memory = arm7_9_read_memory,
939 .write_memory = arm7_9_write_memory,
940 .bulk_write_memory = arm7_9_bulk_write_memory,
941 .checksum_memory = arm7_9_checksum_memory,
942 .blank_check_memory = arm7_9_blank_check_memory,
944 .run_algorithm = armv4_5_run_algorithm,
946 .add_breakpoint = arm7_9_add_breakpoint,
947 .remove_breakpoint = arm7_9_remove_breakpoint,
948 .add_watchpoint = arm7_9_add_watchpoint,
949 .remove_watchpoint = arm7_9_remove_watchpoint,
951 .register_commands = arm9tdmi_register_commands,
952 .target_create = arm9tdmi_target_create,
953 .init_target = arm9tdmi_init_target,
954 .examine = arm7_9_examine,