charm 0.0.1

ARM assembler & disassembler generated from the ARM exploration tools.
Documentation
//! # MSR (Banked register)
//!
//! Move to Banked or Special register from general-purpose register moves the value of a general-purpose register to the Banked general-purpose register or *Saved Program Status Registers (SPSRs)* of the specified mode, or to *ELR_hyp* .

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

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

impl IclassMsrBrA1As {
    /// Tries to decode the instruction in `data`.
    pub(crate) fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let R = (data >> 22) & 1;
        let R_post = R;
        let M = (data >> 8) & 1;
        let M_post = M;
        let M1 = (data >> 16) & 15;
        let M1_post = M1;
        let field_20 = (data >> 20) & 1;
        let field_20_post = field_20;
        let field_6 = (data >> 4) & 7;
        let field_6_post = field_6;
        let field_25 = (data >> 23) & 7;
        let field_25_post = field_25;
        let Rd = (data >> 12) & 15;
        let Rd_post = Rd;
        let field_21 = (data >> 21) & 1;
        let field_21_post = field_21;
        let Rn = (data >> 0) & 15;
        let Rn_post = Rn;
        let field_27 = (data >> 26) & 3;
        let field_27_post = field_27;
        let cond = (data >> 28) & 15;
        let cond_post = cond;
        let B = (data >> 9) & 1;
        let B_post = B;
        let field_7 = (data >> 7) & 1;
        let field_7_post = field_7;
        let field_11 = (data >> 10) & 3;
        let field_11_post = field_11;


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

        unreachable!()
    }
}

/// MSR A1 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="4">!= 1111</td>
///          <td style="text-align: center; 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">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" colspan="1">0</td>
/// <td style="text-align: center" colspan="1">R</td>
///          <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" colspan="4">M1</td>
///          <td style="text-align: center; border-right: none" colspan="3">(1)</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="3">(1)</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="3">(1)</td>
///          <td style="text-align: center; border-left: none" colspan="3">(1)</td>
///          <td style="text-align: center; border-right: none" colspan="3">(0)</td>
///          <td style="text-align: center; border-left: none" colspan="3">(0)</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
/// <td style="text-align: center" colspan="1">M</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">0</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="4">Rn</td>
///     </tr>
///     <tr>
/// <td style="text-align: center; border: none" colspan="4">cond</td>
/// <td style="text-align: center; border: none" colspan="2"></td>
/// <td style="text-align: center; border: none" colspan="3"></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="1"></td>
/// <td style="text-align: center; border: none" colspan="4"></td>
/// <td style="text-align: center; border: none" colspan="4">Rd</td>
/// <td style="text-align: center; border: none" colspan="2"></td>
/// <td style="text-align: center; border: none" colspan="1">B</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="3"></td>
/// <td style="text-align: center; border: none" colspan="4"></td>
///     </tr>
/// </table>
pub struct MsrBrA1As;

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

    /// 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 cond = (data >> 28) & 15;
        let cond_post = cond;
        let R = (data >> 22) & 1;
        let R_post = R;
        let M1 = (data >> 16) & 15;
        let M1_post = M1;
        let M = (data >> 8) & 1;
        let M_post = M;
        let Rn = (data >> 0) & 15;
        let Rn_post = Rn;

        

        // Operand values are computed from the base fields.
        let cond_post = cond;
        let op_0 = MnemonicCondition::decode(cond_post)?;
        let R_post = R;
        let M_post = M;
        let M1_post = M1;
        let op_1 = match (R, M, M1) {
            (0, 0, 0) => BankedRegister::R8Usr,
            (0, 0, 1) => BankedRegister::R9Usr,
            (0, 0, 2) => BankedRegister::R10Usr,
            (0, 0, 3) => BankedRegister::R11Usr,
            (0, 0, 4) => BankedRegister::R12Usr,
            (0, 0, 5) => BankedRegister::SpUsr,
            (0, 0, 6) => BankedRegister::LrUsr,
            (0, 0, 8) => BankedRegister::R8Fiq,
            (0, 0, 9) => BankedRegister::R9Fiq,
            (0, 0, 10) => BankedRegister::R10Fiq,
            (0, 0, 11) => BankedRegister::R11Fiq,
            (0, 0, 12) => BankedRegister::R12Fiq,
            (0, 0, 13) => BankedRegister::SpFiq,
            (0, 0, 14) => BankedRegister::LrFiq,
            (0, 1, 0) => BankedRegister::LrIrq,
            (0, 1, 1) => BankedRegister::SpIrq,
            (0, 1, 2) => BankedRegister::LrSvc,
            (0, 1, 3) => BankedRegister::SpSvc,
            (0, 1, 4) => BankedRegister::LrAbt,
            (0, 1, 5) => BankedRegister::SpAbt,
            (0, 1, 6) => BankedRegister::LrUnd,
            (0, 1, 7) => BankedRegister::SpUnd,
            (0, 1, 12) => BankedRegister::LrMon,
            (0, 1, 13) => BankedRegister::SpMon,
            (0, 1, 14) => BankedRegister::ElrHyp,
            (0, 1, 15) => BankedRegister::SpHyp,
            (1, 0, 14) => BankedRegister::SpsrFiq,
            (1, 1, 0) => BankedRegister::SpsrIrq,
            (1, 1, 2) => BankedRegister::SpsrSvc,
            (1, 1, 4) => BankedRegister::SpsrAbt,
            (1, 1, 6) => BankedRegister::SpsrUnd,
            (1, 1, 12) => BankedRegister::SpsrMon,
            (1, 1, 14) => BankedRegister::SpsrHyp,_ => todo!()
        };
        let Rn_post = Rn;
        let op_2 = Register::decode(Rn_post)?;

        // Instruction creation from the operands.
        let mut instr = Instruction::builder(Code::MSR_br_A1_AS)
            .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 cond_pre = instr.op0().as_mnemonic_condition()?.encode();
        let (R_pre, M_pre, M1_pre) = match instr.op1().as_banked_register()? {
            BankedRegister::R8Usr => (0, 0, 0),
            BankedRegister::R9Usr => (0, 0, 1),
            BankedRegister::R10Usr => (0, 0, 2),
            BankedRegister::R11Usr => (0, 0, 3),
            BankedRegister::R12Usr => (0, 0, 4),
            BankedRegister::SpUsr => (0, 0, 5),
            BankedRegister::LrUsr => (0, 0, 6),
            BankedRegister::R8Fiq => (0, 0, 8),
            BankedRegister::R9Fiq => (0, 0, 9),
            BankedRegister::R10Fiq => (0, 0, 10),
            BankedRegister::R11Fiq => (0, 0, 11),
            BankedRegister::R12Fiq => (0, 0, 12),
            BankedRegister::SpFiq => (0, 0, 13),
            BankedRegister::LrFiq => (0, 0, 14),
            BankedRegister::LrIrq => (0, 1, 0),
            BankedRegister::SpIrq => (0, 1, 1),
            BankedRegister::LrSvc => (0, 1, 2),
            BankedRegister::SpSvc => (0, 1, 3),
            BankedRegister::LrAbt => (0, 1, 4),
            BankedRegister::SpAbt => (0, 1, 5),
            BankedRegister::LrUnd => (0, 1, 6),
            BankedRegister::SpUnd => (0, 1, 7),
            BankedRegister::LrMon => (0, 1, 12),
            BankedRegister::SpMon => (0, 1, 13),
            BankedRegister::ElrHyp => (0, 1, 14),
            BankedRegister::SpHyp => (0, 1, 15),
            BankedRegister::SpsrFiq => (1, 0, 14),
            BankedRegister::SpsrIrq => (1, 1, 0),
            BankedRegister::SpsrSvc => (1, 1, 2),
            BankedRegister::SpsrAbt => (1, 1, 4),
            BankedRegister::SpsrUnd => (1, 1, 6),
            BankedRegister::SpsrMon => (1, 1, 12),
            BankedRegister::SpsrHyp => (1, 1, 14),
        };
        let Rn_pre = instr.op2().as_register()?.encode();

        // Compute all instruction fields from the operand values.
        let cond = (cond_pre & 15);
        let R = (R_pre & 1);
        let M = (M_pre & 1);
        let M1 = (M1_pre & 15);
        let Rn = (Rn_pre & 15);

        // Add all fields to the base instruction encoding.
        let mut instr: u32 = 0b00000001001000001111001000000000;
        instr |= (cond & 15) << 28;
        instr |= (R & 1) << 22;
        instr |= (M & 1) << 8;
        instr |= (M1 & 15) << 16;
        instr |= (Rn & 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::MnemonicCondition(r) = op {
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #1 is valid.
    pub fn check_op1(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::BankedRegister(_) = op {
            return Ok(())
        }
        todo!()
    }
    
    /// Verifies that operand #2 is valid.
    pub fn check_op2(instr: &Instruction, op: &Operand) -> Result<()> {
        if let Operand::Register(r) = op {
            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.msr_br_a1_as, &instr)?;
        fmt.format_operand(output, &config.global, &config.instructions.msr_br_a1_as, &instr, 0)?;
        fmt.format_qualifier(output, &config.global, &config.instructions.msr_br_a1_as, &instr, FormatterQualifier::Wide, false, false)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.msr_br_a1_as, &instr, FormatterTextKind::Space)?;
        fmt.format_operand(output, &config.global, &config.instructions.msr_br_a1_as, &instr, 1)?;
        fmt.format_punctuation(output, &config.global, &config.instructions.msr_br_a1_as, &instr, FormatterTextKind::Comma)?;
        fmt.format_operand(output, &config.global, &config.instructions.msr_br_a1_as, &instr, 2)?;
        Ok(())
    }
}

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

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