charm 0.0.1

ARM assembler & disassembler generated from the ARM exploration tools.
Documentation
//! # TEQ (immediate)
//!
//! Test Equivalence (immediate) performs a bitwise exclusive OR operation on a register value and an immediate value. It updates the condition flags based on the result, and discards the result.

#![allow(non_snake_case)]
#![allow(unused)]
use crate::error::Result;
use crate::utils::*;
use super::super::formatter::*;
use super::super::instruction::*;
use super::super::operand::*;
use super::super::consts::*;
use super::super::config::*;
use super::super::decoder::*;

// ---------------------------------------------------------------------------
// Iclass IclassTeqIT1
// ---------------------------------------------------------------------------

/// Type that represents the IclassTeqIT1 instruction class.
pub(crate) struct IclassTeqIT1;

impl IclassTeqIT1 {
    /// Tries to decode the instruction in `data`.
    pub(crate) fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let imm8 = (data >> 0) & 255;
        let imm8_post = imm8;
        let imm3 = (data >> 12) & 7;
        let imm3_post = imm3;
        let field_28 = (data >> 27) & 3;
        let field_28_post = field_28;
        let S = (data >> 20) & 1;
        let S_post = S;
        let i = (data >> 26) & 1;
        let i_post = i;
        let field_31 = (data >> 29) & 7;
        let field_31_post = field_31;
        let Rn = (data >> 16) & 15;
        let Rn_post = Rn;
        let field_25 = (data >> 25) & 1;
        let field_25_post = field_25;
        let field_15 = (data >> 15) & 1;
        let field_15_post = field_15;
        let Rd = (data >> 8) & 15;
        let Rd_post = Rd;
        let op1 = (data >> 21) & 15;
        let op1_post = op1;


        return TeqIT1::decode(data as u32, decoder);

        unreachable!()
    }
}

/// TEQ T1 encoding.
///
/// # Encoding
///
/// <table style="font-family: courier, monospace">
///     <tr>
///         <td style="border: none">31</td>
///         <td style="border: none">30</td>
///         <td style="border: none">29</td>
///         <td style="border: none">28</td>
///         <td style="border: none">27</td>
///         <td style="border: none">26</td>
///         <td style="border: none">25</td>
///         <td style="border: none">24</td>
///         <td style="border: none">23</td>
///         <td style="border: none">22</td>
///         <td style="border: none">21</td>
///         <td style="border: none">20</td>
///         <td style="border: none">19</td>
///         <td style="border: none">18</td>
///         <td style="border: none">17</td>
///         <td style="border: none">16</td>
///         <td style="border: none">15</td>
///         <td style="border: none">14</td>
///         <td style="border: none">13</td>
///         <td style="border: none">12</td>
///         <td style="border: none">11</td>
///         <td style="border: none">10</td>
///         <td style="border: none">9</td>
///         <td style="border: none">8</td>
///         <td style="border: none">7</td>
///         <td style="border: none">6</td>
///         <td style="border: none">5</td>
///         <td style="border: none">4</td>
///         <td style="border: none">3</td>
///         <td style="border: none">2</td>
///         <td style="border: none">1</td>
///         <td style="border: none">0</td>
///     </tr>
///     <tr>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="1">i</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
/// <td style="text-align: center" colspan="4">Rn</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="3">imm3</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">1</td>
/// <td style="text-align: center" colspan="8">imm8</td>
///     </tr>
///     <tr>
/// <td style="text-align: center; border: none" colspan="3"></td>
/// <td style="text-align: center; border: none" colspan="2"></td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="4">op1</td>
/// <td style="text-align: center; border: none" colspan="1">S</td>
/// <td style="text-align: center; border: none" colspan="4"></td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="3"></td>
/// <td style="text-align: center; border: none" colspan="4">Rd</td>
/// <td style="text-align: center; border: none" colspan="8"></td>
///     </tr>
/// </table>
pub struct TeqIT1;

impl TeqIT1 {
    /// Returns the instruction mnemonic.
    pub fn mnemonic(_instr: &Instruction) -> Mnemonic {
        Mnemonic::TEQ
    }

    /// Returns the instruction condition information.
    pub fn condition(instr: &Instruction) -> ConditionalInstruction {
        ConditionalInstruction::Condition(0, false, false)
    }

    /// Returns the instruction size.
    pub fn size(_instr: &Instruction) -> usize {4}

    /// Decodes the instruction in `data`.
    pub fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        // Fields are extracted from the input value.
        let i = (data >> 26) & 1;
        let i_post = i;
        let Rn = (data >> 16) & 15;
        let Rn_post = Rn;
        let imm3 = (data >> 12) & 7;
        let imm3_post = imm3;
        let imm8 = (data >> 0) & 255;
        let imm8_post = imm8;
        
        // Compute the dependency values for the operands.
        let i_imm3_imm8_post = (i << 11) | (imm3 << 8) | imm8;
        let Rn_post = Rn;

        // Operand values are computed from the base fields and the dependencies.
        let op_0 = MnemonicCondition::Al;
        let op_1 = Register::decode(Rn_post)?;
        let op_2 = ModifiedImmediate::decode(i_imm3_imm8_post);

        // Instruction creation from the operands.
        let mut instr = Instruction::builder(Code::TEQ_i_T1)
            .operand(0, op_0)?
            .operand(1, op_1)?
            .operand(2, op_2)?
            .build();
        
        Ok(instr)
    }

    pub fn encode(instr: &Instruction, buf: &mut Vec<u8>) -> Result<usize> {
        // Retrieve all operand values.
        let Rn_pre = instr.op1().as_register()?.encode();
        let i_imm3_imm8_pre = instr.op2().as_modified_immediate()?.encode();

        // Compute all instruction fields from the operand values.
        let Rn = (Rn_pre & 15);
        let imm8 = (i_imm3_imm8_pre & 255);
        let imm3 = (i_imm3_imm8_pre >> 8) & 7;
        let i = (i_imm3_imm8_pre >> 11) & 1;

        // Add all fields to the base instruction encoding.
        let mut instr: u32 = 0b11110000100100000000111100000000;
        instr |= (Rn & 15) << 16;
        instr |= (imm8 & 255) << 0;
        instr |= (imm3 & 7) << 12;
        instr |= (i & 1) << 26;

        let instr_1 = (instr & 0xffff) as u16;
        let instr_2 = ((instr >> 16) & 0xffff) as u16;
        buf.extend(instr_2.to_le_bytes());
        buf.extend(instr_1.to_le_bytes());
        Ok(4)
    }

    /// Encode an instruction part of an instruction block into `buf`.
    pub fn encode_block(instr: &mut Instruction, buf: &mut Vec<u8>, labels: &std::collections::HashMap<u64, u64>) -> Result<usize> {
        Self::encode(instr, buf)
    }
    
    /// Verifies that operand #0 is valid.
    pub fn check_op0(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::MnemonicCondition(r) = op {
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #1 is valid.
    pub fn check_op1(instr: &Instruction, op: &Operand) -> Result<()> {
        
        if let Operand::Register(r) = op {
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #2 is valid.
    pub fn check_op2(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::ModifiedImmediate(i) = op {
            if i.0 >= 1 << 13 {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #3 is valid.
    pub fn check_op3(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #4 is valid.
    pub fn check_op4(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #5 is valid.
    pub fn check_op5(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }
    
    /// Verifies that operand #6 is valid.
    pub fn check_op6(instr: &Instruction, op: &Operand) -> Result<()> {
        todo!()
    }

    /// Formats the instruction.
    pub fn format(instr: &Instruction, fmt: &mut impl Formatter, output: &mut impl FormatterOutput, config: &Config) -> Result<()> {
        fmt.format_mnemonic(output, &config.global, &config.instructions.teq_i_t1, &instr)?;
        fmt.format_operand(output, &config.global, &config.instructions.teq_i_t1, &instr, 0)?;
        fmt.format_qualifier(output, &config.global, &config.instructions.teq_i_t1, &instr, FormatterQualifier::Wide, false, false)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.teq_i_t1, &instr, FormatterTextKind::Space)?;
        fmt.format_operand(output, &config.global, &config.instructions.teq_i_t1, &instr, 1)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.teq_i_t1, &instr, FormatterTextKind::Comma)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.teq_i_t1, &instr, FormatterTextKind::NumSign)?;
        fmt.format_operand(output, &config.global, &config.instructions.teq_i_t1, &instr, 2)?;
        Ok(())
    }
}

/// Type that represents alias identifiers for [`TeqIT1`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
pub enum TeqIT1Aliases {
    None,
}

/// Type that represents encoding identifiers for [`TeqIT1`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
pub enum TeqIT1Encodings {
    None
}