1 /***************************************************************************
2 * Copyright (C) 2006 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2008 by Hongtao Zheng *
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 ***************************************************************************/
28 #include "arm_disassembler.h"
29 #include "arm_simulator.h"
31 #include "binarybuffer.h"
34 uint32_t arm_shift(uint8_t shift
, uint32_t Rm
, uint32_t shift_amount
, uint8_t *carry
)
36 uint32_t return_value
= 0;
39 if (shift
== 0x0) /* LSL */
41 if ((shift_amount
> 0) && (shift_amount
<= 32))
43 return_value
= Rm
<< shift_amount
;
44 *carry
= Rm
>> (32 - shift_amount
);
46 else if (shift_amount
> 32)
51 else /* (shift_amount == 0) */
56 else if (shift
== 0x1) /* LSR */
58 if ((shift_amount
> 0) && (shift_amount
<= 32))
60 return_value
= Rm
>> shift_amount
;
61 *carry
= (Rm
>> (shift_amount
- 1)) & 1;
63 else if (shift_amount
> 32)
68 else /* (shift_amount == 0) */
73 else if (shift
== 0x2) /* ASR */
75 if ((shift_amount
> 0) && (shift_amount
<= 32))
77 /* right shifts of unsigned values are guaranteed to be logical (shift in zeroes)
78 * simulate an arithmetic shift (shift in signed-bit) by adding the signed-bit manually */
79 return_value
= Rm
>> shift_amount
;
81 return_value
|= 0xffffffff << (32 - shift_amount
);
83 else if (shift_amount
> 32)
87 return_value
= 0xffffffff;
96 else /* (shift_amount == 0) */
101 else if (shift
== 0x3) /* ROR */
103 if (shift_amount
== 0)
109 shift_amount
= shift_amount
% 32;
110 return_value
= (Rm
>> shift_amount
) | (Rm
<< (32 - shift_amount
));
111 *carry
= (return_value
>> 31) & 0x1;
114 else if (shift
== 0x4) /* RRX */
116 return_value
= Rm
>> 1;
126 uint32_t arm_shifter_operand(struct arm_sim_interface
*sim
, int variant
, union arm_shifter_operand shifter_operand
, uint8_t *shifter_carry_out
)
128 uint32_t return_value
;
129 int instruction_size
;
131 if (sim
->get_state(sim
) == ARMV4_5_STATE_ARM
)
132 instruction_size
= 4;
134 instruction_size
= 2;
136 *shifter_carry_out
= sim
->get_cpsr(sim
, 29, 1);
138 if (variant
== 0) /* 32-bit immediate */
140 return_value
= shifter_operand
.immediate
.immediate
;
142 else if (variant
== 1) /* immediate shift */
144 uint32_t Rm
= sim
->get_reg_mode(sim
, shifter_operand
.immediate_shift
.Rm
);
146 /* adjust RM in case the PC is being read */
147 if (shifter_operand
.immediate_shift
.Rm
== 15)
148 Rm
+= 2 * instruction_size
;
150 return_value
= arm_shift(shifter_operand
.immediate_shift
.shift
, Rm
, shifter_operand
.immediate_shift
.shift_imm
, shifter_carry_out
);
152 else if (variant
== 2) /* register shift */
154 uint32_t Rm
= sim
->get_reg_mode(sim
, shifter_operand
.register_shift
.Rm
);
155 uint32_t Rs
= sim
->get_reg_mode(sim
, shifter_operand
.register_shift
.Rs
);
157 /* adjust RM in case the PC is being read */
158 if (shifter_operand
.register_shift
.Rm
== 15)
159 Rm
+= 2 * instruction_size
;
161 return_value
= arm_shift(shifter_operand
.immediate_shift
.shift
, Rm
, Rs
, shifter_carry_out
);
165 LOG_ERROR("BUG: shifter_operand.variant not 0, 1 or 2");
166 return_value
= 0xffffffff;
172 int pass_condition(uint32_t cpsr
, uint32_t opcode
)
174 switch ((opcode
& 0xf0000000) >> 28)
177 if (cpsr
& 0x40000000)
182 if (!(cpsr
& 0x40000000))
187 if (cpsr
& 0x20000000)
192 if (!(cpsr
& 0x20000000))
197 if (cpsr
& 0x80000000)
202 if (!(cpsr
& 0x80000000))
207 if (cpsr
& 0x10000000)
212 if (!(cpsr
& 0x10000000))
217 if ((cpsr
& 0x20000000) && !(cpsr
& 0x40000000))
222 if (!(cpsr
& 0x20000000) || (cpsr
& 0x40000000))
227 if (((cpsr
& 0x80000000) && (cpsr
& 0x10000000))
228 || (!(cpsr
& 0x80000000) && !(cpsr
& 0x10000000)))
233 if (((cpsr
& 0x80000000) && !(cpsr
& 0x10000000))
234 || (!(cpsr
& 0x80000000) && (cpsr
& 0x10000000)))
239 if (!(cpsr
& 0x40000000) &&
240 (((cpsr
& 0x80000000) && (cpsr
& 0x10000000))
241 || (!(cpsr
& 0x80000000) && !(cpsr
& 0x10000000))))
246 if ((cpsr
& 0x40000000) ||
247 ((cpsr
& 0x80000000) && !(cpsr
& 0x10000000))
248 || (!(cpsr
& 0x80000000) && (cpsr
& 0x10000000)))
258 LOG_ERROR("BUG: should never get here");
262 int thumb_pass_branch_condition(uint32_t cpsr
, uint16_t opcode
)
264 return pass_condition(cpsr
, (opcode
& 0x0f00) << 20);
267 /* simulate a single step (if possible)
268 * if the dry_run_pc argument is provided, no state is changed,
269 * but the new pc is stored in the variable pointed at by the argument
271 int arm_simulate_step_core(target_t
*target
, uint32_t *dry_run_pc
, struct arm_sim_interface
*sim
)
273 uint32_t current_pc
= sim
->get_reg(sim
, 15);
274 arm_instruction_t instruction
;
275 int instruction_size
;
276 int retval
= ERROR_OK
;
278 if (sim
->get_state(sim
) == ARMV4_5_STATE_ARM
)
282 /* get current instruction, and identify it */
283 if ((retval
= target_read_u32(target
, current_pc
, &opcode
)) != ERROR_OK
)
287 if ((retval
= arm_evaluate_opcode(opcode
, current_pc
, &instruction
)) != ERROR_OK
)
291 instruction_size
= 4;
293 /* check condition code (for all instructions) */
294 if (!pass_condition(sim
->get_cpsr(sim
, 0, 32), opcode
))
298 *dry_run_pc
= current_pc
+ instruction_size
;
302 sim
->set_reg(sim
, 15, current_pc
+ instruction_size
);
312 retval
= target_read_u16(target
, current_pc
, &opcode
);
313 if (retval
!= ERROR_OK
)
315 retval
= thumb_evaluate_opcode(opcode
, current_pc
, &instruction
);
316 if (retval
!= ERROR_OK
)
318 instruction_size
= 2;
320 /* check condition code (only for branch instructions) */
321 if (instruction
.type
== ARM_B
&&
322 !thumb_pass_branch_condition(sim
->get_cpsr(sim
, 0, 32), opcode
))
326 *dry_run_pc
= current_pc
+ instruction_size
;
330 sim
->set_reg(sim
, 15, current_pc
+ instruction_size
);
337 /* examine instruction type */
339 /* branch instructions */
340 if ((instruction
.type
>= ARM_B
) && (instruction
.type
<= ARM_BLX
))
344 if (instruction
.info
.b_bl_bx_blx
.reg_operand
== -1)
346 target
= instruction
.info
.b_bl_bx_blx
.target_address
;
350 target
= sim
->get_reg_mode(sim
, instruction
.info
.b_bl_bx_blx
.reg_operand
);
351 if (instruction
.info
.b_bl_bx_blx
.reg_operand
== 15)
353 target
+= 2 * instruction_size
;
359 *dry_run_pc
= target
& ~1;
364 if (instruction
.type
== ARM_B
)
366 sim
->set_reg(sim
, 15, target
);
368 else if (instruction
.type
== ARM_BL
)
370 uint32_t old_pc
= sim
->get_reg(sim
, 15);
371 sim
->set_reg_mode(sim
, 14, old_pc
+ 4);
372 sim
->set_reg(sim
, 15, target
);
374 else if (instruction
.type
== ARM_BX
)
378 sim
->set_state(sim
, ARMV4_5_STATE_THUMB
);
382 sim
->set_state(sim
, ARMV4_5_STATE_ARM
);
384 sim
->set_reg(sim
, 15, target
& 0xfffffffe);
386 else if (instruction
.type
== ARM_BLX
)
388 uint32_t old_pc
= sim
->get_reg(sim
, 15);
389 sim
->set_reg_mode(sim
, 14, old_pc
+ 4);
393 sim
->set_state(sim
, ARMV4_5_STATE_THUMB
);
397 sim
->set_state(sim
, ARMV4_5_STATE_ARM
);
399 sim
->set_reg(sim
, 15, target
& 0xfffffffe);
405 /* data processing instructions, except compare instructions (CMP, CMN, TST, TEQ) */
406 else if (((instruction
.type
>= ARM_AND
) && (instruction
.type
<= ARM_RSC
))
407 || ((instruction
.type
>= ARM_ORR
) && (instruction
.type
<= ARM_MVN
)))
409 uint32_t Rd
, Rn
, shifter_operand
;
410 uint8_t C
= sim
->get_cpsr(sim
, 29, 1);
414 /* ARM_MOV and ARM_MVN does not use Rn */
415 if ((instruction
.type
!= ARM_MOV
) && (instruction
.type
!= ARM_MVN
))
416 Rn
= sim
->get_reg_mode(sim
, instruction
.info
.data_proc
.Rn
);
420 shifter_operand
= arm_shifter_operand(sim
, instruction
.info
.data_proc
.variant
, instruction
.info
.data_proc
.shifter_operand
, &carry_out
);
422 /* adjust Rn in case the PC is being read */
423 if (instruction
.info
.data_proc
.Rn
== 15)
424 Rn
+= 2 * instruction_size
;
426 if (instruction
.type
== ARM_AND
)
427 Rd
= Rn
& shifter_operand
;
428 else if (instruction
.type
== ARM_EOR
)
429 Rd
= Rn
^ shifter_operand
;
430 else if (instruction
.type
== ARM_SUB
)
431 Rd
= Rn
- shifter_operand
;
432 else if (instruction
.type
== ARM_RSB
)
433 Rd
= shifter_operand
- Rn
;
434 else if (instruction
.type
== ARM_ADD
)
435 Rd
= Rn
+ shifter_operand
;
436 else if (instruction
.type
== ARM_ADC
)
437 Rd
= Rn
+ shifter_operand
+ (C
& 1);
438 else if (instruction
.type
== ARM_SBC
)
439 Rd
= Rn
- shifter_operand
- (C
& 1) ? 0 : 1;
440 else if (instruction
.type
== ARM_RSC
)
441 Rd
= shifter_operand
- Rn
- (C
& 1) ? 0 : 1;
442 else if (instruction
.type
== ARM_ORR
)
443 Rd
= Rn
| shifter_operand
;
444 else if (instruction
.type
== ARM_BIC
)
445 Rd
= Rn
& ~(shifter_operand
);
446 else if (instruction
.type
== ARM_MOV
)
447 Rd
= shifter_operand
;
448 else if (instruction
.type
== ARM_MVN
)
449 Rd
= ~shifter_operand
;
451 LOG_WARNING("unhandled instruction type");
455 if (instruction
.info
.data_proc
.Rd
== 15)
462 *dry_run_pc
= current_pc
+ instruction_size
;
469 sim
->set_reg_mode(sim
, instruction
.info
.data_proc
.Rd
, Rd
);
470 LOG_WARNING("no updating of flags yet");
472 if (instruction
.info
.data_proc
.Rd
== 15)
476 /* compare instructions (CMP, CMN, TST, TEQ) */
477 else if ((instruction
.type
>= ARM_TST
) && (instruction
.type
<= ARM_CMN
))
481 *dry_run_pc
= current_pc
+ instruction_size
;
486 LOG_WARNING("no updating of flags yet");
489 /* load register instructions */
490 else if ((instruction
.type
>= ARM_LDR
) && (instruction
.type
<= ARM_LDRSH
))
492 uint32_t load_address
= 0, modified_address
= 0, load_value
;
493 uint32_t Rn
= sim
->get_reg_mode(sim
, instruction
.info
.load_store
.Rn
);
495 /* adjust Rn in case the PC is being read */
496 if (instruction
.info
.load_store
.Rn
== 15)
497 Rn
+= 2 * instruction_size
;
499 if (instruction
.info
.load_store
.offset_mode
== 0)
501 if (instruction
.info
.load_store
.U
)
502 modified_address
= Rn
+ instruction
.info
.load_store
.offset
.offset
;
504 modified_address
= Rn
- instruction
.info
.load_store
.offset
.offset
;
506 else if (instruction
.info
.load_store
.offset_mode
== 1)
509 uint32_t Rm
= sim
->get_reg_mode(sim
, instruction
.info
.load_store
.offset
.reg
.Rm
);
510 uint8_t shift
= instruction
.info
.load_store
.offset
.reg
.shift
;
511 uint8_t shift_imm
= instruction
.info
.load_store
.offset
.reg
.shift_imm
;
512 uint8_t carry
= sim
->get_cpsr(sim
, 29, 1);
514 offset
= arm_shift(shift
, Rm
, shift_imm
, &carry
);
516 if (instruction
.info
.load_store
.U
)
517 modified_address
= Rn
+ offset
;
519 modified_address
= Rn
- offset
;
523 LOG_ERROR("BUG: offset_mode neither 0 (offset) nor 1 (scaled register)");
526 if (instruction
.info
.load_store
.index_mode
== 0)
529 * we load from the modified address, but don't change the base address register */
530 load_address
= modified_address
;
531 modified_address
= Rn
;
533 else if (instruction
.info
.load_store
.index_mode
== 1)
536 * we load from the modified address, and write it back to the base address register */
537 load_address
= modified_address
;
539 else if (instruction
.info
.load_store
.index_mode
== 2)
542 * we load from the unmodified address, and write the modified address back */
546 if ((!dry_run_pc
) || (instruction
.info
.load_store
.Rd
== 15))
548 if ((retval
= target_read_u32(target
, load_address
, &load_value
)) != ERROR_OK
)
556 if (instruction
.info
.load_store
.Rd
== 15)
558 *dry_run_pc
= load_value
;
563 *dry_run_pc
= current_pc
+ instruction_size
;
570 if ((instruction
.info
.load_store
.index_mode
== 1) ||
571 (instruction
.info
.load_store
.index_mode
== 2))
573 sim
->set_reg_mode(sim
, instruction
.info
.load_store
.Rn
, modified_address
);
575 sim
->set_reg_mode(sim
, instruction
.info
.load_store
.Rd
, load_value
);
577 if (instruction
.info
.load_store
.Rd
== 15)
581 /* load multiple instruction */
582 else if (instruction
.type
== ARM_LDM
)
585 uint32_t Rn
= sim
->get_reg_mode(sim
, instruction
.info
.load_store_multiple
.Rn
);
586 uint32_t load_values
[16];
589 for (i
= 0; i
< 16; i
++)
591 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
595 switch (instruction
.info
.load_store_multiple
.addressing_mode
)
597 case 0: /* Increment after */
600 case 1: /* Increment before */
603 case 2: /* Decrement after */
604 Rn
= Rn
- (bits_set
* 4) + 4;
606 case 3: /* Decrement before */
607 Rn
= Rn
- (bits_set
* 4);
611 for (i
= 0; i
< 16; i
++)
613 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
615 if ((!dry_run_pc
) || (i
== 15))
617 target_read_u32(target
, Rn
, &load_values
[i
]);
625 if (instruction
.info
.load_store_multiple
.register_list
& 0x8000)
627 *dry_run_pc
= load_values
[15];
633 enum armv4_5_mode mode
= sim
->get_mode(sim
);
636 if (instruction
.info
.load_store_multiple
.S
)
638 if (instruction
.info
.load_store_multiple
.register_list
& 0x8000)
641 mode
= ARMV4_5_MODE_USR
;
644 for (i
= 0; i
< 16; i
++)
646 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
648 sim
->set_reg_mode(sim
, i
, load_values
[i
]);
654 uint32_t spsr
= sim
->get_reg_mode(sim
, 16);
655 sim
->set_reg(sim
, ARMV4_5_CPSR
, spsr
);
658 /* base register writeback */
659 if (instruction
.info
.load_store_multiple
.W
)
660 sim
->set_reg_mode(sim
, instruction
.info
.load_store_multiple
.Rn
, Rn
);
662 if (instruction
.info
.load_store_multiple
.register_list
& 0x8000)
666 /* store multiple instruction */
667 else if (instruction
.type
== ARM_STM
)
673 /* STM wont affect PC (advance by instruction size */
677 uint32_t Rn
= sim
->get_reg_mode(sim
, instruction
.info
.load_store_multiple
.Rn
);
679 enum armv4_5_mode mode
= sim
->get_mode(sim
);
681 for (i
= 0; i
< 16; i
++)
683 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
687 if (instruction
.info
.load_store_multiple
.S
)
689 mode
= ARMV4_5_MODE_USR
;
692 switch (instruction
.info
.load_store_multiple
.addressing_mode
)
694 case 0: /* Increment after */
697 case 1: /* Increment before */
700 case 2: /* Decrement after */
701 Rn
= Rn
- (bits_set
* 4) + 4;
703 case 3: /* Decrement before */
704 Rn
= Rn
- (bits_set
* 4);
708 for (i
= 0; i
< 16; i
++)
710 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
712 target_write_u32(target
, Rn
, sim
->get_reg_mode(sim
, i
));
717 /* base register writeback */
718 if (instruction
.info
.load_store_multiple
.W
)
719 sim
->set_reg_mode(sim
, instruction
.info
.load_store_multiple
.Rn
, Rn
);
723 else if (!dry_run_pc
)
725 /* the instruction wasn't handled, but we're supposed to simulate it
727 LOG_ERROR("Unimplemented instruction, could not simulate it.");
733 *dry_run_pc
= current_pc
+ instruction_size
;
738 sim
->set_reg(sim
, 15, current_pc
+ instruction_size
);
744 static uint32_t armv4_5_get_reg(struct arm_sim_interface
*sim
, int reg
)
746 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
748 return buf_get_u32(armv4_5
->core_cache
->reg_list
[reg
].value
, 0, 32);
751 static void armv4_5_set_reg(struct arm_sim_interface
*sim
, int reg
, uint32_t value
)
753 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
755 buf_set_u32(armv4_5
->core_cache
->reg_list
[reg
].value
, 0, 32, value
);
758 static uint32_t armv4_5_get_reg_mode(struct arm_sim_interface
*sim
, int reg
)
760 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
762 return buf_get_u32(ARMV4_5_CORE_REG_MODE(armv4_5
->core_cache
, armv4_5
->core_mode
, reg
).value
, 0, 32);
765 static void armv4_5_set_reg_mode(struct arm_sim_interface
*sim
, int reg
, uint32_t value
)
767 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
769 buf_set_u32(ARMV4_5_CORE_REG_MODE(armv4_5
->core_cache
, armv4_5
->core_mode
, reg
).value
, 0, 32, value
);
772 static uint32_t armv4_5_get_cpsr(struct arm_sim_interface
*sim
, int pos
, int bits
)
774 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
776 return buf_get_u32(armv4_5
->core_cache
->reg_list
[ARMV4_5_CPSR
].value
, pos
, bits
);
779 static enum armv4_5_state
armv4_5_get_state(struct arm_sim_interface
*sim
)
781 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
783 return armv4_5
->core_state
;
786 static void armv4_5_set_state(struct arm_sim_interface
*sim
, enum armv4_5_state mode
)
788 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
790 armv4_5
->core_state
= mode
;
794 static enum armv4_5_mode
armv4_5_get_mode(struct arm_sim_interface
*sim
)
796 armv4_5_common_t
*armv4_5
= (armv4_5_common_t
*)sim
->user_data
;
798 return armv4_5
->core_mode
;
803 int arm_simulate_step(target_t
*target
, uint32_t *dry_run_pc
)
805 armv4_5_common_t
*armv4_5
= target
->arch_info
;
807 struct arm_sim_interface sim
;
809 sim
.user_data
=armv4_5
;
810 sim
.get_reg
=&armv4_5_get_reg
;
811 sim
.set_reg
=&armv4_5_set_reg
;
812 sim
.get_reg_mode
=&armv4_5_get_reg_mode
;
813 sim
.set_reg_mode
=&armv4_5_set_reg_mode
;
814 sim
.get_cpsr
=&armv4_5_get_cpsr
;
815 sim
.get_mode
=&armv4_5_get_mode
;
816 sim
.get_state
=&armv4_5_get_state
;
817 sim
.set_state
=&armv4_5_set_state
;
819 return arm_simulate_step_core(target
, dry_run_pc
, &sim
);