autd3_driver/firmware/fpga/
emit_intensity.rs

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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
use autd3_derive::Builder;

use derive_more::Debug;
use derive_new::new;
use zerocopy::{Immutable, IntoBytes};

/// The intensity of the ultrasound.
#[derive(
    Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Builder, new, IntoBytes, Immutable,
)]
#[debug("{:#04X}", self.value)]
#[repr(C)]
pub struct EmitIntensity {
    #[get]
    /// The value of the intensity.
    value: u8,
}

impl EmitIntensity {
    /// Maximum intensity.
    pub const MAX: EmitIntensity = EmitIntensity { value: 255 };
    /// Minimum intensity.
    pub const MIN: EmitIntensity = EmitIntensity { value: 0 };
}

impl From<u8> for EmitIntensity {
    fn from(v: u8) -> Self {
        Self::new(v)
    }
}

impl std::ops::Div<u8> for EmitIntensity {
    type Output = Self;

    fn div(self, rhs: u8) -> Self::Output {
        Self::new(self.value / rhs)
    }
}

impl std::ops::Mul<u8> for EmitIntensity {
    type Output = EmitIntensity;

    fn mul(self, rhs: u8) -> Self::Output {
        Self::Output::new(self.value.saturating_mul(rhs))
    }
}

impl std::ops::Mul<EmitIntensity> for u8 {
    type Output = EmitIntensity;

    fn mul(self, rhs: EmitIntensity) -> Self::Output {
        Self::Output::new(self.saturating_mul(rhs.value))
    }
}

impl std::ops::Add<EmitIntensity> for EmitIntensity {
    type Output = Self;

    fn add(self, rhs: EmitIntensity) -> Self::Output {
        Self::new(self.value.saturating_add(rhs.value))
    }
}

impl std::ops::Sub<EmitIntensity> for EmitIntensity {
    type Output = Self;

    fn sub(self, rhs: EmitIntensity) -> Self::Output {
        Self::new(self.value.saturating_sub(rhs.value))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[rstest::rstest]
    #[test]
    #[case::value_0(0x00)]
    #[case::value_1(0x01)]
    #[case::value_ff(0xFF)]
    fn test_new(#[case] expected: u8) {
        assert_eq!(expected, EmitIntensity::new(expected).value(),);
    }

    #[rstest::rstest]
    #[test]
    #[case::value_1_1(EmitIntensity::new(0x01), EmitIntensity::new(0x01), 1)]
    #[case::value_1_2(EmitIntensity::new(0x00), EmitIntensity::new(0x01), 2)]
    #[case::value_ff_2(EmitIntensity::new(0x7F), EmitIntensity::new(0xFF), 2)]
    fn test_div(#[case] expected: EmitIntensity, #[case] target: EmitIntensity, #[case] div: u8) {
        assert_eq!(expected, target / div);
    }

    #[rstest::rstest]
    #[test]
    #[case::value_1_1(EmitIntensity::new(0x01), EmitIntensity::new(0x01), 1)]
    #[case::value_1_2(EmitIntensity::new(0x02), EmitIntensity::new(0x01), 2)]
    #[case::value_7f_2(EmitIntensity::new(0xFE), EmitIntensity::new(0x7F), 2)]
    #[case::value_7f_3(EmitIntensity::new(0xFF), EmitIntensity::new(0x7F), 3)]
    fn test_mul(#[case] expected: EmitIntensity, #[case] target: EmitIntensity, #[case] mul: u8) {
        assert_eq!(expected, target * mul);
        assert_eq!(expected, mul * target);
    }

    #[rstest::rstest]
    #[test]
    #[case::value_1_1(
        EmitIntensity::new(0x02),
        EmitIntensity::new(0x01),
        EmitIntensity::new(0x01)
    )]
    #[case::value_7f_7f(
        EmitIntensity::new(0xFE),
        EmitIntensity::new(0x7F),
        EmitIntensity::new(0x7F)
    )]
    #[case::value_7f_ff(
        EmitIntensity::new(0xFF),
        EmitIntensity::new(0x7F),
        EmitIntensity::new(0xFF)
    )]
    fn test_add(
        #[case] expected: EmitIntensity,
        #[case] lhs: EmitIntensity,
        #[case] rhs: EmitIntensity,
    ) {
        assert_eq!(expected, lhs + rhs);
    }

    #[rstest::rstest]
    #[test]
    #[case::value_1_1(
        EmitIntensity::new(0x00),
        EmitIntensity::new(0x01),
        EmitIntensity::new(0x01)
    )]
    #[case::value_7f_7f(
        EmitIntensity::new(0x01),
        EmitIntensity::new(0x02),
        EmitIntensity::new(0x01)
    )]
    #[case::value_7f_ff(
        EmitIntensity::new(0x00),
        EmitIntensity::new(0x7F),
        EmitIntensity::new(0xFF)
    )]
    fn test_sub(
        #[case] expected: EmitIntensity,
        #[case] lhs: EmitIntensity,
        #[case] rhs: EmitIntensity,
    ) {
        assert_eq!(expected, lhs - rhs);
    }

    #[test]
    fn dbg() {
        assert_eq!(format!("{:?}", EmitIntensity::new(0x00)), "0x00");
        assert_eq!(format!("{:?}", EmitIntensity::new(0x01)), "0x01");
        assert_eq!(format!("{:?}", EmitIntensity::new(0xFF)), "0xFF");
    }
}