Skip to main content

ab_riscv_primitives/instructions/rv64/b/
zbc.rs

1//! RV64 Zbc 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 RV64 Zbc instruction (Carryless multiplication)
12#[instruction]
13#[derive(Debug, Clone, Copy, PartialEq, Eq)]
14pub enum Rv64ZbcInstruction<Reg> {
15    Clmul { rd: Reg, rs1: Reg, rs2: Reg },
16    Clmulh { rd: Reg, rs1: Reg, rs2: Reg },
17    Clmulr { rd: Reg, rs1: Reg, rs2: Reg },
18}
19
20#[instruction]
21const impl<Reg> Instruction for Rv64ZbcInstruction<Reg>
22where
23    Reg: [const] Register<Type = u64>,
24{
25    type Reg = Reg;
26
27    #[inline(always)]
28    #[cfg_attr(feature = "no-panic", no_panic_const::no_panic(const))]
29    fn try_decode(instruction: u32) -> Option<Self> {
30        let opcode = (instruction & 0b111_1111) as u8;
31        let rd_bits = ((instruction >> 7) & 0x1f) as u8;
32        let funct3 = ((instruction >> 12) & 0b111) as u8;
33        let rs1_bits = ((instruction >> 15) & 0x1f) as u8;
34        let rs2_bits = ((instruction >> 20) & 0x1f) as u8;
35        let funct7 = ((instruction >> 25) & 0b111_1111) as u8;
36
37        match opcode {
38            // R-type
39            0b011_0011 => {
40                let rd = Reg::from_bits(rd_bits)?;
41                let rs1 = Reg::from_bits(rs1_bits)?;
42                let rs2 = Reg::from_bits(rs2_bits)?;
43                match (funct3, funct7) {
44                    (0b001, 0b000_0101) => Some(Self::Clmul { rd, rs1, rs2 }),
45                    (0b011, 0b000_0101) => Some(Self::Clmulh { rd, rs1, rs2 }),
46                    (0b010, 0b000_0101) => Some(Self::Clmulr { rd, rs1, rs2 }),
47                    _ => None,
48                }
49            }
50            _ => None,
51        }
52    }
53
54    #[inline(always)]
55    fn alignment() -> u8 {
56        align_of::<u32>() as u8
57    }
58
59    #[inline(always)]
60    fn size(&self) -> u8 {
61        size_of::<u32>() as u8
62    }
63}
64
65#[instruction]
66impl<Reg> fmt::Display for Rv64ZbcInstruction<Reg>
67where
68    Reg: fmt::Display,
69{
70    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
71        match self {
72            Self::Clmul { rd, rs1, rs2 } => write!(f, "clmul {rd}, {rs1}, {rs2}"),
73            Self::Clmulh { rd, rs1, rs2 } => write!(f, "clmulh {rd}, {rs1}, {rs2}"),
74            Self::Clmulr { rd, rs1, rs2 } => write!(f, "clmulr {rd}, {rs1}, {rs2}"),
75        }
76    }
77}