2024-02-17 02:35:49 +00:00
|
|
|
//
|
2024-02-21 20:32:27 +00:00
|
|
|
// OperationMapper.hpp
|
2024-02-17 02:35:49 +00:00
|
|
|
// Clock Signal
|
|
|
|
//
|
|
|
|
// Created by Thomas Harte on 16/02/2024.
|
|
|
|
// Copyright © 2024 Thomas Harte. All rights reserved.
|
|
|
|
//
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2024-02-21 19:17:01 +00:00
|
|
|
#include "../../Reflection/Dispatcher.hpp"
|
|
|
|
|
2024-02-17 02:35:49 +00:00
|
|
|
namespace InstructionSet::ARM {
|
|
|
|
|
2024-02-21 20:32:27 +00:00
|
|
|
enum class Model {
|
|
|
|
ARM2,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class Operation {
|
|
|
|
/// Rd = Op1 AND Op2.
|
|
|
|
AND,
|
|
|
|
/// Rd = Op1 EOR Op2.
|
|
|
|
EOR,
|
|
|
|
/// Rd = Op1 - Op2.
|
|
|
|
SUB,
|
|
|
|
/// Rd = Op2 - Op1.
|
|
|
|
RSB,
|
|
|
|
/// Rd = Op1 + Op2.
|
|
|
|
ADD,
|
|
|
|
/// Rd = Op1 + Ord2 + C.
|
|
|
|
ADC,
|
|
|
|
/// Rd = Op1 - Op2 + C.
|
|
|
|
SBC,
|
|
|
|
/// Rd = Op2 - Op1 + C.
|
|
|
|
RSC,
|
|
|
|
/// Set condition codes on Op1 AND Op2.
|
|
|
|
TST,
|
|
|
|
/// Set condition codes on Op1 EOR Op2.
|
|
|
|
TEQ,
|
|
|
|
/// Set condition codes on Op1 - Op2.
|
|
|
|
CMP,
|
|
|
|
/// Set condition codes on Op1 + Op2.
|
|
|
|
CMN,
|
|
|
|
/// Rd = Op1 OR Op2.
|
|
|
|
ORR,
|
|
|
|
/// Rd = Op2
|
|
|
|
MOV,
|
|
|
|
/// Rd = Op1 AND NOT Op2.
|
|
|
|
BIC,
|
|
|
|
/// Rd = NOT Op2.
|
|
|
|
MVN,
|
|
|
|
|
|
|
|
MUL, MLA,
|
|
|
|
B, BL,
|
|
|
|
|
|
|
|
LDR, STR,
|
|
|
|
LDM, STM,
|
|
|
|
SWI,
|
|
|
|
|
|
|
|
CDP,
|
|
|
|
MRC, MCR,
|
|
|
|
LDC, STC,
|
|
|
|
|
|
|
|
Undefined,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class Condition {
|
|
|
|
EQ, NE, CS, CC,
|
|
|
|
MI, PL, VS, VC,
|
|
|
|
HI, LS, GE, LT,
|
|
|
|
GT, LE, AL, NV,
|
|
|
|
};
|
|
|
|
|
2024-02-21 19:17:01 +00:00
|
|
|
enum class ShiftType {
|
|
|
|
LogicalLeft = 0b00,
|
|
|
|
LogicalRight = 0b01,
|
|
|
|
ArithmeticRight = 0b10,
|
|
|
|
RotateRight = 0b11,
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
static constexpr int FlagsStartBit = 20;
|
|
|
|
|
|
|
|
template <int position>
|
|
|
|
constexpr bool flag_bit(uint8_t flags) {
|
|
|
|
static_assert(position >= 20 && position < 28);
|
|
|
|
return flags & (1 << (position - FlagsStartBit));
|
|
|
|
}
|
|
|
|
|
2024-02-21 19:51:51 +00:00
|
|
|
struct WithShiftControlBits {
|
|
|
|
constexpr WithShiftControlBits(uint32_t opcode) noexcept : opcode_(opcode) {}
|
|
|
|
|
|
|
|
/// The operand 2 register index if @c operand2_is_immediate() is @c false; meaningless otherwise.
|
|
|
|
int operand2() const { return opcode_ & 0xf; }
|
|
|
|
/// The type of shift to apply to operand 2 if @c operand2_is_immediate() is @c false; meaningless otherwise.
|
|
|
|
ShiftType shift_type() const { return ShiftType((opcode_ >> 5) & 3); }
|
|
|
|
/// @returns @c true if the amount to shift by should be taken from a register; @c false if it is an immediate value.
|
|
|
|
bool shift_count_is_register() const { return opcode_ & (1 << 4); }
|
|
|
|
/// The shift amount register index if @c shift_count_is_register() is @c true; meaningless otherwise.
|
|
|
|
int shift_register() const { return (opcode_ >> 8) & 0xf; }
|
|
|
|
/// The amount to shift by if @c shift_count_is_register() is @c false; meaningless otherwise.
|
|
|
|
int shift_amount() const { return (opcode_ >> 7) & 0x1f; }
|
|
|
|
|
|
|
|
protected:
|
|
|
|
uint32_t opcode_;
|
|
|
|
};
|
|
|
|
|
2024-02-21 19:17:01 +00:00
|
|
|
//
|
|
|
|
// Data processing (i.e. AND to MVN).
|
|
|
|
//
|
|
|
|
struct DataProcessingFlags {
|
|
|
|
constexpr DataProcessingFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
/// @returns @c true if operand 2 is defined by the @c rotate() and @c immediate() fields;
|
|
|
|
/// @c false if it is defined by the @c shift_*() and @c operand2() fields.
|
|
|
|
constexpr bool operand2_is_immediate() { return flag_bit<25>(flags_); }
|
|
|
|
|
|
|
|
constexpr bool set_condition_codes() { return flag_bit<20>(flags_); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
2024-02-21 19:51:51 +00:00
|
|
|
struct DataProcessing: public WithShiftControlBits {
|
|
|
|
using WithShiftControlBits::WithShiftControlBits;
|
2024-02-21 19:17:01 +00:00
|
|
|
|
|
|
|
/// The destination register index. i.e. Rd.
|
|
|
|
int destination() const { return (opcode_ >> 12) & 0xf; }
|
|
|
|
|
|
|
|
/// The operand 1 register index. i.e. Rn.
|
|
|
|
int operand1() const { return (opcode_ >> 16) & 0xf; }
|
|
|
|
|
|
|
|
//
|
|
|
|
// Immediate values for operand 2.
|
|
|
|
//
|
|
|
|
|
|
|
|
/// An 8-bit value to rotate right @c rotate() places if @c operand2_is_immediate() is @c true; meaningless otherwise.
|
|
|
|
int immediate() const { return opcode_ & 0xff; }
|
|
|
|
/// The number of bits to rotate @c immediate() by to the right if @c operand2_is_immediate() is @c true; meaningless otherwise.
|
|
|
|
int rotate() const { return (opcode_ >> 7) & 0x1e; }
|
|
|
|
};
|
|
|
|
|
|
|
|
//
|
|
|
|
// MUL and MLA.
|
|
|
|
//
|
|
|
|
struct MultiplyFlags {
|
|
|
|
constexpr MultiplyFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr bool set_condition_codes() { return flag_bit<20>(flags_); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct Multiply {
|
|
|
|
constexpr Multiply(uint32_t opcode) noexcept : opcode_(opcode) {}
|
|
|
|
|
|
|
|
/// The destination register index. i.e. 'Rd'.
|
|
|
|
int destination() const { return (opcode_ >> 16) & 0xf; }
|
|
|
|
|
|
|
|
/// The accumulator register index for multiply-add. i.e. 'Rn'.
|
|
|
|
int accumulator() const { return (opcode_ >> 12) & 0xf; }
|
|
|
|
|
|
|
|
/// The multiplicand register index. i.e. 'Rs'.
|
|
|
|
int multiplicand() const { return (opcode_ >> 8) & 0xf; }
|
|
|
|
|
|
|
|
/// The multiplier register index. i.e. 'Rm'.
|
|
|
|
int multiplier() const { return opcode_ & 0xf; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint32_t opcode_;
|
|
|
|
};
|
|
|
|
|
2024-02-21 19:51:51 +00:00
|
|
|
//
|
|
|
|
// Single data transfer (LDR, STR).
|
|
|
|
//
|
|
|
|
struct SingleDataTransferFlags {
|
|
|
|
constexpr SingleDataTransferFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr bool offset_is_immediate() { return flag_bit<25>(flags_); }
|
|
|
|
constexpr bool pre_index() { return flag_bit<24>(flags_); }
|
|
|
|
constexpr bool add_offset() { return flag_bit<23>(flags_); }
|
|
|
|
constexpr bool transfer_byte() { return flag_bit<22>(flags_); }
|
|
|
|
constexpr bool write_back_address() { return flag_bit<21>(flags_); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct SingleDataTransfer: public WithShiftControlBits {
|
|
|
|
using WithShiftControlBits::WithShiftControlBits;
|
|
|
|
|
|
|
|
/// The destination register index. i.e. 'Rd' for LDR.
|
|
|
|
int destination() const { return (opcode_ >> 12) & 0xf; }
|
|
|
|
|
|
|
|
/// The destination register index. i.e. 'Rd' for STR.
|
|
|
|
int source() const { return (opcode_ >> 12) & 0xf; }
|
|
|
|
|
|
|
|
/// The base register index. i.e. 'Rn'.
|
|
|
|
int base() const { return (opcode_ >> 16) & 0xf; }
|
|
|
|
|
|
|
|
/// The immediate offset, if @c offset_is_immediate() was @c true; meaningless otherwise.
|
|
|
|
int immediate() const { return opcode_ & 0xfff; }
|
|
|
|
};
|
|
|
|
|
2024-02-21 20:25:57 +00:00
|
|
|
//
|
|
|
|
// Block data transfer (LDR, STR).
|
|
|
|
//
|
|
|
|
struct BlockDataTransferFlags {
|
|
|
|
constexpr BlockDataTransferFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr bool pre_index() { return flag_bit<24>(flags_); }
|
|
|
|
constexpr bool add_offset() { return flag_bit<23>(flags_); }
|
|
|
|
constexpr bool load_psr() { return flag_bit<22>(flags_); }
|
|
|
|
constexpr bool write_back_address() { return flag_bit<21>(flags_); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct BlockDataTransfer: public WithShiftControlBits {
|
|
|
|
using WithShiftControlBits::WithShiftControlBits;
|
|
|
|
|
|
|
|
/// The base register index. i.e. 'Rn'.
|
|
|
|
int base() const { return (opcode_ >> 16) & 0xf; }
|
|
|
|
|
|
|
|
/// A bitfield indicating which registers to load or store.
|
|
|
|
int register_list() const { return opcode_ & 0xffff; }
|
|
|
|
};
|
|
|
|
|
|
|
|
//
|
|
|
|
// Coprocessor data operation and register transfer.
|
|
|
|
//
|
|
|
|
struct CoprocessorDataOperationFlags {
|
|
|
|
constexpr CoprocessorDataOperationFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr int operation() const { return (flags_ >> (FlagsStartBit - 20)) & 0xf; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct CoprocessorRegisterTransferFlags {
|
|
|
|
constexpr CoprocessorRegisterTransferFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr int operation() const { return (flags_ >> (FlagsStartBit - 20)) & 0x7; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct CoprocessorOperationOrRegisterTransfer {
|
|
|
|
constexpr CoprocessorOperationOrRegisterTransfer(uint32_t opcode) noexcept : opcode_(opcode) {}
|
|
|
|
|
|
|
|
int operand1() { return (opcode_ >> 16) & 0xf; }
|
|
|
|
int operand2() { return opcode_ & 0xf; }
|
|
|
|
int destination() { return (opcode_ >> 12) & 0xf; }
|
|
|
|
int coprocessor() { return (opcode_ >> 8) & 0xf; }
|
|
|
|
int information() { return (opcode_ >> 5) & 0x7; }
|
|
|
|
|
2024-02-21 20:32:27 +00:00
|
|
|
private:
|
|
|
|
uint32_t opcode_;
|
|
|
|
};
|
|
|
|
|
|
|
|
//
|
|
|
|
// Coprocessor data transfer.
|
|
|
|
//
|
|
|
|
struct CoprocessorDataTransferFlags {
|
|
|
|
constexpr CoprocessorDataTransferFlags(uint8_t flags) noexcept : flags_(flags) {}
|
|
|
|
|
|
|
|
constexpr bool pre_index() { return flag_bit<24>(flags_); }
|
|
|
|
constexpr bool add_offset() { return flag_bit<23>(flags_); }
|
|
|
|
constexpr bool transfer_length() { return flag_bit<22>(flags_); }
|
|
|
|
constexpr bool write_back_address() { return flag_bit<21>(flags_); }
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint8_t flags_;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct CoprocessorDataTransfer {
|
|
|
|
constexpr CoprocessorDataTransfer(uint32_t opcode) noexcept : opcode_(opcode) {}
|
|
|
|
|
|
|
|
int base() { return (opcode_ >> 16) & 0xf; }
|
|
|
|
|
|
|
|
int source() { return (opcode_ >> 12) & 0xf; }
|
|
|
|
int destination() { return (opcode_ >> 12) & 0xf; }
|
|
|
|
|
|
|
|
int coprocessor() { return (opcode_ >> 8) & 0xf; }
|
|
|
|
int offset() { return opcode_ & 0xff; }
|
|
|
|
|
|
|
|
private:
|
2024-02-21 20:25:57 +00:00
|
|
|
uint32_t opcode_;
|
|
|
|
};
|
2024-02-21 19:17:01 +00:00
|
|
|
|
2024-02-21 20:32:27 +00:00
|
|
|
/// Operation mapper; use the free function @c dispatch as defined below.
|
2024-02-21 19:17:01 +00:00
|
|
|
struct OperationMapper {
|
|
|
|
template <int i, typename SchedulerT> void dispatch(uint32_t instruction, SchedulerT &scheduler) {
|
2024-02-21 20:25:57 +00:00
|
|
|
constexpr auto partial = uint32_t(i << 20);
|
|
|
|
const auto condition = Condition(instruction >> 28);
|
2024-02-21 19:17:01 +00:00
|
|
|
|
2024-02-21 19:18:41 +00:00
|
|
|
// Cf. the ARM2 datasheet, p.45. Tests below match its ordering
|
|
|
|
// other than that 'undefined' is the fallthrough case. More specific
|
|
|
|
// page references are provided were more detailed versions of the
|
|
|
|
// decoding are depicted.
|
|
|
|
|
2024-02-21 19:17:01 +00:00
|
|
|
// Data processing; cf. p.17.
|
|
|
|
if constexpr (((partial >> 26) & 0b11) == 0b00) {
|
|
|
|
constexpr auto operation = Operation(int(Operation::AND) + ((partial >> 21) & 0xf));
|
|
|
|
constexpr auto flags = DataProcessingFlags(i);
|
|
|
|
scheduler.template data_processing<operation, flags>(
|
2024-02-21 20:25:57 +00:00
|
|
|
condition,
|
2024-02-21 19:17:01 +00:00
|
|
|
DataProcessing(instruction)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Multiply and multiply-accumulate (MUL, MLA); cf. p.23.
|
2024-02-21 19:51:51 +00:00
|
|
|
if constexpr (((partial >> 22) & 0b111'111) == 0b000'000) {
|
|
|
|
// This implementation provides only eight bits baked into the template parameters so
|
|
|
|
// an additional dynamic test is required to check whether this is really, really MUL or MLA.
|
2024-02-21 19:17:01 +00:00
|
|
|
if(((instruction >> 4) & 0b1111) != 0b1001) {
|
|
|
|
scheduler.unknown(instruction);
|
|
|
|
} else {
|
|
|
|
constexpr bool is_mla = partial & (1 << 21);
|
|
|
|
constexpr auto flags = MultiplyFlags(i);
|
|
|
|
scheduler.template multiply<is_mla ? Operation::MLA : Operation::MUL, flags>(
|
2024-02-21 20:25:57 +00:00
|
|
|
condition,
|
2024-02-21 19:17:01 +00:00
|
|
|
Multiply(instruction)
|
|
|
|
);
|
|
|
|
}
|
2024-02-21 19:51:51 +00:00
|
|
|
}
|
2024-02-21 19:17:01 +00:00
|
|
|
|
2024-02-21 19:51:51 +00:00
|
|
|
// Single data transfer (LDR, STR); cf. p.25.
|
|
|
|
if constexpr (((partial >> 26) & 0b11) == 0b01) {
|
|
|
|
constexpr bool is_ldr = partial & (1 << 20);
|
|
|
|
constexpr auto flags = SingleDataTransferFlags(i);
|
|
|
|
scheduler.template single_data_transfer<is_ldr ? Operation::LDR : Operation::STR, flags>(
|
2024-02-21 20:25:57 +00:00
|
|
|
condition,
|
2024-02-21 19:51:51 +00:00
|
|
|
SingleDataTransfer(instruction)
|
|
|
|
);
|
2024-02-21 19:17:01 +00:00
|
|
|
}
|
2024-02-21 20:25:57 +00:00
|
|
|
|
|
|
|
// Block data transfer (LDM, STM); cf. p.29.
|
|
|
|
if constexpr (((partial >> 25) & 0b111) == 0b100) {
|
|
|
|
constexpr bool is_ldm = partial & (1 << 20);
|
|
|
|
constexpr auto flags = BlockDataTransferFlags(i);
|
|
|
|
scheduler.template block_data_transfer<is_ldm ? Operation::LDM : Operation::STM, flags>(
|
|
|
|
condition,
|
|
|
|
BlockDataTransfer(instruction)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Branch and branch with link (B, BL); cf. p.15.
|
|
|
|
if constexpr (((partial >> 25) & 0b111) == 0b101) {
|
|
|
|
constexpr bool is_bl = partial & (1 << 24);
|
|
|
|
scheduler.template branch<is_bl ? Operation::BL : Operation::B>(
|
|
|
|
condition,
|
|
|
|
(instruction & 0xf'ffff) << 2
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Software interreupt; cf. p.35.
|
|
|
|
if constexpr (((partial >> 24) & 0b1111) == 0b1111) {
|
|
|
|
scheduler.software_interrupt(condition);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// Both:
|
|
|
|
// Coprocessor data operation; cf. p. 37; and
|
|
|
|
// Coprocessor register transfers; cf. p. 42.
|
|
|
|
if constexpr (((partial >> 24) & 0b1111) == 0b1110) {
|
|
|
|
const auto parameters = CoprocessorOperationOrRegisterTransfer(instruction);
|
|
|
|
|
|
|
|
// TODO: parameters should probably vary.
|
|
|
|
|
|
|
|
if(instruction & (1 << 4)) {
|
|
|
|
// Register transfer.
|
|
|
|
constexpr auto flags = CoprocessorRegisterTransferFlags(i);
|
|
|
|
constexpr bool is_mrc = partial & (1 << 20);
|
|
|
|
scheduler.template coprocessor_register_transfer<is_mrc ? Operation::MRC : Operation::MCR, flags>(
|
|
|
|
condition,
|
|
|
|
parameters
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
// Data operation.
|
|
|
|
constexpr auto flags = CoprocessorDataOperationFlags(i);
|
|
|
|
scheduler.template coprocessor_data_operation<flags>(
|
|
|
|
condition,
|
|
|
|
parameters
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
2024-02-21 20:32:27 +00:00
|
|
|
|
|
|
|
// Coprocessor data transfers; cf. p.39.
|
|
|
|
if constexpr (((partial >> 25) & 0b111) == 0b110) {
|
|
|
|
constexpr bool is_ldc = partial & (1 << 20);
|
|
|
|
constexpr auto flags = CoprocessorDataTransferFlags(i);
|
|
|
|
scheduler.template coprocessor_data_transfer<is_ldc ? Operation::LDC : Operation::STC, flags>(
|
|
|
|
condition,
|
|
|
|
CoprocessorDataTransfer(instruction)
|
|
|
|
);
|
|
|
|
}
|
2024-02-21 19:17:01 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2024-02-21 19:18:41 +00:00
|
|
|
/// Decodes @c instruction, making an appropriate call into @c scheduler.
|
2024-02-21 19:17:01 +00:00
|
|
|
template <typename SchedulerT> void dispatch(uint32_t instruction, SchedulerT &scheduler) {
|
|
|
|
OperationMapper mapper;
|
2024-02-21 19:51:51 +00:00
|
|
|
Reflection::dispatch(mapper, (instruction >> FlagsStartBit) & 0xff, instruction, scheduler);
|
2024-02-21 19:17:01 +00:00
|
|
|
}
|
|
|
|
|
2024-02-17 02:35:49 +00:00
|
|
|
}
|