charm 0.0.1

ARM assembler & disassembler generated from the ARM exploration tools.
Documentation
//! # RMIF
//!
//! This instruction performs a rotation right of a value held in a general-purpose register by an immediate value, and then inserts a selection of the bottom four bits of the result of the rotation into the PSTATE flags, under the control of a second immediate mask.

#![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 IclassRmifOnlyRmif
// ---------------------------------------------------------------------------

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

impl IclassRmifOnlyRmif {
    /// Tries to decode the instruction in `data`.
    pub(crate) fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let field_14 = (data >> 10) & 31;
        let field_14_post = field_14;
        let S = (data >> 29) & 1;
        let S_post = S;
        let field_27 = (data >> 25) & 7;
        let field_27_post = field_27;
        let o2 = (data >> 4) & 1;
        let o2_post = o2;
        let op = (data >> 30) & 1;
        let op_post = op;
        let Rn = (data >> 5) & 31;
        let Rn_post = Rn;
        let mask = (data >> 0) & 15;
        let mask_post = mask;
        let sf = (data >> 31) & 1;
        let sf_post = sf;
        let field_24 = (data >> 21) & 15;
        let field_24_post = field_24;
        let imm6 = (data >> 15) & 63;
        let imm6_post = imm6;
        let field_28 = (data >> 28) & 1;
        let field_28_post = field_28;


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

        unreachable!()
    }
}

/// None-bit 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-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: 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; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none" colspan="1">1</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">0</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" colspan="6">imm6</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">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</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">1</td>
/// <td style="text-align: center" colspan="5">Rn</td>
///          <td style="text-align: center; border-right: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="4">mask</td>
///     </tr>
///     <tr>
/// <td style="text-align: center; border: none" colspan="1">sf</td>
/// <td style="text-align: center; border: none" colspan="1">op</td>
/// <td style="text-align: center; border: none" colspan="1">S</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"></td>
/// <td style="text-align: center; border: none" colspan="6"></td>
/// <td style="text-align: center; border: none" colspan="5"></td>
/// <td style="text-align: center; border: none" colspan="5"></td>
/// <td style="text-align: center; border: none" colspan="1">o2</td>
/// <td style="text-align: center; border: none" colspan="4"></td>
///     </tr>
/// </table>
pub struct RmifOnlyRmif;

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

    /// 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 imm6 = (data >> 15) & 63;
        let imm6_post = imm6;
        let Rn = (data >> 5) & 31;
        let Rn_post = Rn;
        let mask = (data >> 0) & 15;
        let mask_post = mask;
        

        // Operand values are computed from the base fields.
        let Rn_post = Rn;
        let op_0 = Register::aarch64(Rn_post, false)?;
        let imm6_post = imm6;
        let op_1 = imm6_post as u32;
        let mask_post = mask;
        let op_2 = mask_post as u32;

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

    /// Encodes the instruction into `buf`.
    pub fn encode(instr: &Instruction, buf: &mut Vec<u8>) -> Result<usize> {
        // Retrieve all operand values.
        let Rn_pre = instr.op0().as_register()?.encode();
        let imm6_pre = instr.op1().as_unsigned_immediate()? as u32;
        let mask_pre = instr.op2().as_unsigned_immediate()? as u32;

        // Compute all instruction fields from the operand values.
        let Rn = (Rn_pre & 31);
        let imm6_pre = imm6_pre;
        let imm6 = (imm6_pre & 63);
        let mask_pre = mask_pre;
        let mask = (mask_pre & 15);

        // Add all fields to the base instruction encoding.
        let mut instr: u32 = 0b10111010000000000000010000000000;
        instr |= (Rn & 31) << 5;
        instr |= (imm6 & 63) << 15;
        instr |= (mask & 15) << 0;

        let bytes = instr.to_le_bytes();
        let len = bytes.len();
        buf.extend(bytes);
        Ok(len)
    }

    /// 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::Register(r) = op {
            if !r.is_aarch64() {
                todo!()
            }
            
            if *r == Register::SP {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #1 is valid.
    pub fn check_op1(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::UnsignedImmediate(i) = op {
            if !(0..=63).contains(i) {
                todo!()
            }
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #2 is valid.
    pub fn check_op2(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::UnsignedImmediate(i) = op {
            if !(0..=15).contains(i) {
                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.rmif_only_rmif, instr)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.rmif_only_rmif, instr, FormatterTextKind::Space)?;
        fmt.format_operand(output, &config.global, &config.instructions.rmif_only_rmif, instr, 0)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.rmif_only_rmif, instr, FormatterTextKind::Comma)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.rmif_only_rmif, instr, FormatterTextKind::NumSign)?;
        fmt.format_operand(output, &config.global, &config.instructions.rmif_only_rmif, instr, 1)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.rmif_only_rmif, instr, FormatterTextKind::Comma)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.rmif_only_rmif, instr, FormatterTextKind::NumSign)?;
        fmt.format_operand(output, &config.global, &config.instructions.rmif_only_rmif, instr, 2)?;
        Ok(())
    }
}

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