Skip to main content

ab_riscv_primitives/instructions/rv32/zk/
zbkx.rs

1//! RV32 Zbkx extension
2
3#[cfg(test)]
4mod tests;
5
6use crate::instructions::Instruction;
7use crate::registers::general_purpose::Register;
8use ab_riscv_macros::instruction;
9use core::fmt;
10
11/// RISC-V RV32 Zbkx instruction (Crossbar permutations)
12#[instruction]
13#[derive(Debug, Clone, Copy, PartialEq, Eq)]
14pub enum Rv32ZbkxInstruction<Reg> {
15    Xperm4 { rd: Reg, rs1: Reg, rs2: Reg },
16    Xperm8 { rd: Reg, rs1: Reg, rs2: Reg },
17}
18
19#[instruction]
20const impl<Reg> Instruction for Rv32ZbkxInstruction<Reg>
21where
22    Reg: [const] Register<Type = u32>,
23{
24    type Reg = Reg;
25
26    #[inline(always)]
27    #[cfg_attr(feature = "no-panic", no_panic_const::no_panic(const))]
28    fn try_decode(instruction: u32) -> Option<Self> {
29        let opcode = (instruction & 0b111_1111) as u8;
30        let rd_bits = ((instruction >> 7) & 0x1f) as u8;
31        let funct3 = ((instruction >> 12) & 0b111) as u8;
32        let rs1_bits = ((instruction >> 15) & 0x1f) as u8;
33        let rs2_bits = ((instruction >> 20) & 0x1f) as u8;
34        let funct7 = ((instruction >> 25) & 0b111_1111) as u8;
35
36        match opcode {
37            0b011_0011 => {
38                let rd = Reg::from_bits(rd_bits)?;
39                let rs1 = Reg::from_bits(rs1_bits)?;
40                let rs2 = Reg::from_bits(rs2_bits)?;
41                match (funct3, funct7) {
42                    (0b010, 0b001_0100) => Some(Self::Xperm4 { rd, rs1, rs2 }),
43                    (0b100, 0b001_0100) => Some(Self::Xperm8 { rd, rs1, rs2 }),
44                    _ => None,
45                }
46            }
47            _ => None,
48        }
49    }
50
51    #[inline(always)]
52    fn alignment() -> u8 {
53        align_of::<u32>() as u8
54    }
55
56    #[inline(always)]
57    fn size(&self) -> u8 {
58        size_of::<u32>() as u8
59    }
60}
61
62#[instruction]
63impl<Reg> fmt::Display for Rv32ZbkxInstruction<Reg>
64where
65    Reg: fmt::Display,
66{
67    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
68        match self {
69            Self::Xperm4 { rd, rs1, rs2 } => write!(f, "xperm4 {rd}, {rs1}, {rs2}"),
70            Self::Xperm8 { rd, rs1, rs2 } => write!(f, "xperm8 {rd}, {rs1}, {rs2}"),
71        }
72    }
73}