1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use super::{SILENCER_CTL_FLAG_FIXED_COMPLETION_STEPS, SILENCER_CTL_FLAG_STRICT_MODE};
use crate::{
    error::AUTDInternalError,
    firmware::{
        fpga::{SILENCER_VALUE_MAX, SILENCER_VALUE_MIN},
        operation::{cast, Operation, TypeTag},
    },
    geometry::Device,
};

#[repr(C, align(2))]
struct SilencerFixedCompletionSteps {
    tag: TypeTag,
    flag: u8,
    value_intensity: u16,
    value_phase: u16,
}

pub struct SilencerFixedCompletionStepsOp {
    is_done: bool,
    value_intensity: u16,
    value_phase: u16,
    strict_mode: bool,
}

impl SilencerFixedCompletionStepsOp {
    pub fn new(value_intensity: u16, value_phase: u16, strict_mode: bool) -> Self {
        Self {
            is_done: false,
            value_intensity,
            value_phase,
            strict_mode,
        }
    }
}

impl Operation for SilencerFixedCompletionStepsOp {
    fn pack(&mut self, _: &Device, tx: &mut [u8]) -> Result<usize, AUTDInternalError> {
        if !(SILENCER_VALUE_MIN..=SILENCER_VALUE_MAX).contains(&self.value_intensity) {
            return Err(AUTDInternalError::SilencerCompletionStepsOutOfRange(
                self.value_intensity,
            ));
        }
        if !(SILENCER_VALUE_MIN..=SILENCER_VALUE_MAX).contains(&self.value_phase) {
            return Err(AUTDInternalError::SilencerCompletionStepsOutOfRange(
                self.value_phase,
            ));
        }

        *cast::<SilencerFixedCompletionSteps>(tx) = SilencerFixedCompletionSteps {
            tag: TypeTag::Silencer,
            flag: SILENCER_CTL_FLAG_FIXED_COMPLETION_STEPS
                | if self.strict_mode {
                    SILENCER_CTL_FLAG_STRICT_MODE
                } else {
                    0
                },
            value_intensity: self.value_intensity,
            value_phase: self.value_phase,
        };

        self.is_done = true;
        Ok(std::mem::size_of::<SilencerFixedCompletionSteps>())
    }

    fn required_size(&self, _: &Device) -> usize {
        std::mem::size_of::<SilencerFixedCompletionSteps>()
    }

    fn is_done(&self) -> bool {
        self.is_done
    }
}

#[cfg(test)]
mod tests {
    use std::mem::size_of;

    use super::*;
    use crate::geometry::tests::create_device;

    const NUM_TRANS_IN_UNIT: usize = 249;

    #[rstest::rstest]
    #[test]
    #[case(SILENCER_CTL_FLAG_STRICT_MODE, true)]
    #[case(0x00, false)]
    fn test(#[case] value: u8, #[case] strict_mode: bool) {
        let device = create_device(0, NUM_TRANS_IN_UNIT);

        let mut tx = [0x00u8; size_of::<SilencerFixedCompletionSteps>()];

        let mut op = SilencerFixedCompletionStepsOp::new(0x1234, 0x5678, strict_mode);

        assert_eq!(
            op.required_size(&device),
            size_of::<SilencerFixedCompletionSteps>()
        );
        assert!(!op.is_done());

        assert!(op.pack(&device, &mut tx).is_ok());

        assert!(op.is_done());

        assert_eq!(tx[0], TypeTag::Silencer as u8);
        assert_eq!(tx[1], value);
        assert_eq!(tx[2], 0x34);
        assert_eq!(tx[3], 0x12);
        assert_eq!(tx[4], 0x78);
        assert_eq!(tx[5], 0x56);
    }

    #[rstest::rstest]
    #[test]
    #[case(Ok(size_of::<SilencerFixedCompletionSteps>()), SILENCER_VALUE_MIN, SILENCER_VALUE_MIN)]
    #[case(Ok(size_of::<SilencerFixedCompletionSteps>()), SILENCER_VALUE_MAX, SILENCER_VALUE_MAX)]
    #[case(Err(AUTDInternalError::SilencerCompletionStepsOutOfRange(0)), SILENCER_VALUE_MAX, SILENCER_VALUE_MIN - 1)]
    #[case(Err(AUTDInternalError::SilencerCompletionStepsOutOfRange(0)), SILENCER_VALUE_MIN - 1, SILENCER_VALUE_MAX)]
    fn out_of_range(
        #[case] expected: Result<usize, AUTDInternalError>,
        #[case] value_intensity: u16,
        #[case] value_phase: u16,
    ) {
        const FRAME_SIZE: usize = size_of::<SilencerFixedCompletionSteps>() + NUM_TRANS_IN_UNIT * 2;

        let device = create_device(0, NUM_TRANS_IN_UNIT);
        let mut tx = vec![0x00u8; FRAME_SIZE];

        let mut op = SilencerFixedCompletionStepsOp::new(value_intensity, value_phase, true);

        assert_eq!(expected, op.pack(&device, &mut tx));
    }
}