sdmmc_core/command/class/class0/cmd8/
arg.rs

1use crate::lib_bitfield;
2use crate::result::{Error, Result};
3
4mod vhs;
5
6pub use vhs::*;
7
8lib_bitfield! {
9    /// Argumentument for CMD8.
10    pub Argument(u32): u8 {
11        /// Programs the supply voltage of the card.
12        raw_vhs: 11, 8;
13        /// Programs the check pattern of the card.
14        raw_check_pattern: 7, 0;
15    }
16}
17
18impl Argument {
19    /// Represents the byte length of the [Argument].
20    pub const LEN: usize = 4;
21    /// Represents the default value of the [Argument].
22    pub const DEFAULT: u32 = 0x0100;
23
24    /// Creates a new [Argument].
25    pub const fn new() -> Self {
26        Self(Self::DEFAULT)
27    }
28
29    /// Gets the `Voltage Host Supplied` field of the [Argument].
30    pub const fn vhs(&self) -> Result<VoltageSupplied> {
31        VoltageSupplied::from_raw(self.raw_vhs())
32    }
33
34    /// Sets the `Voltage Host Supplied` field of the [Argument].
35    pub fn set_vhs(&mut self, val: VoltageSupplied) {
36        self.set_raw_vhs(val.into_raw() as u32);
37    }
38
39    /// Gets the check pattern field of the [Argument].
40    pub const fn check_pattern(&self) -> u8 {
41        self.raw_check_pattern()
42    }
43
44    /// Sets the check pattern field of the [Argument].
45    pub fn set_check_pattern(&mut self, val: u8) {
46        self.set_raw_check_pattern(val as u32);
47    }
48
49    /// Attempts to convert a [`u32`] into an [Argument].
50    pub const fn try_from_bits(val: u32) -> Result<Self> {
51        match Self(val) {
52            arg if arg.vhs().is_err() => Err(Error::invalid_field_variant(
53                "cmd::argument::vhs",
54                arg.raw_vhs() as usize,
55            )),
56            arg => Ok(arg),
57        }
58    }
59
60    /// Converts the [Argument] into a byte array.
61    pub const fn bytes(&self) -> [u8; Self::LEN] {
62        self.0.to_be_bytes()
63    }
64
65    /// Attempts to convert a byte slice into an [Argument].
66    pub const fn try_from_bytes(val: &[u8]) -> Result<Self> {
67        match val.len() {
68            len if len < Self::LEN => Err(Error::invalid_length(len, Self::LEN)),
69            _ => Self::try_from_bits(u32::from_be_bytes([val[0], val[1], val[2], val[3]])),
70        }
71    }
72}
73
74impl Default for Argument {
75    fn default() -> Self {
76        Self::new()
77    }
78}
79
80impl From<Argument> for u32 {
81    fn from(val: Argument) -> Self {
82        val.bits()
83    }
84}
85
86impl From<Argument> for [u8; Argument::LEN] {
87    fn from(val: Argument) -> Self {
88        val.bytes()
89    }
90}
91
92impl TryFrom<u32> for Argument {
93    type Error = Error;
94
95    fn try_from(val: u32) -> Result<Argument> {
96        Argument::try_from_bits(val)
97    }
98}
99
100impl TryFrom<&[u8]> for Argument {
101    type Error = Error;
102
103    fn try_from(val: &[u8]) -> Result<Argument> {
104        Argument::try_from_bytes(val)
105    }
106}
107
108impl<const N: usize> TryFrom<&[u8; N]> for Argument {
109    type Error = Error;
110
111    fn try_from(val: &[u8; N]) -> Result<Argument> {
112        Argument::try_from_bytes(val.as_ref())
113    }
114}
115
116impl<const N: usize> TryFrom<[u8; N]> for Argument {
117    type Error = Error;
118
119    fn try_from(val: [u8; N]) -> Result<Argument> {
120        Argument::try_from_bytes(val.as_ref())
121    }
122}
123
124#[cfg(test)]
125mod tests {
126    use super::*;
127
128    #[test]
129    fn test_fields() {
130        let arg = Argument::new();
131        let new_vhs = VoltageSupplied::new();
132
133        assert_eq!(arg.vhs(), Ok(new_vhs));
134        assert_eq!(arg.check_pattern(), 0);
135
136        (1..=12).map(|r| (1u32 << r) - 1).for_each(|raw_arg| {
137            let raw = raw_arg.to_be_bytes();
138            let raw_vhs = (raw_arg >> 8) as u8;
139            let exp_check = (raw_arg & 0xff) as u8;
140
141            match VoltageSupplied::from_raw(raw_vhs) {
142                Ok(exp_vhs) => {
143                    let mut exp_arg = Argument(raw_arg);
144
145                    assert_eq!(Argument::try_from_bits(raw_arg), Ok(exp_arg));
146                    assert_eq!(Argument::try_from_bytes(&raw), Ok(exp_arg));
147                    assert_eq!(Argument::try_from(&raw), Ok(exp_arg));
148                    assert_eq!(Argument::try_from(raw), Ok(exp_arg));
149
150                    assert_eq!(exp_arg.vhs(), Ok(exp_vhs));
151
152                    exp_arg.set_vhs(new_vhs);
153                    assert_eq!(exp_arg.vhs(), Ok(new_vhs));
154
155                    exp_arg.set_vhs(exp_vhs);
156                    assert_eq!(exp_arg.vhs(), Ok(exp_vhs));
157
158                    assert_eq!(exp_arg.check_pattern(), exp_check);
159
160                    exp_arg.set_check_pattern(0);
161                    assert_eq!(exp_arg.check_pattern(), 0);
162
163                    exp_arg.set_check_pattern(exp_check);
164                    assert_eq!(exp_arg.check_pattern(), exp_check);
165
166                    assert_eq!(exp_arg.bits(), raw_arg);
167                    assert_eq!(exp_arg.bytes(), raw);
168                }
169                Err(_) => {
170                    let exp_err =
171                        Error::invalid_field_variant("cmd::argument::vhs", raw_vhs as usize);
172
173                    assert_eq!(Argument::try_from_bits(raw_arg), Err(exp_err));
174                    assert_eq!(Argument::try_from_bytes(&raw), Err(exp_err));
175                    assert_eq!(Argument::try_from(&raw), Err(exp_err));
176                    assert_eq!(Argument::try_from(raw), Err(exp_err));
177                }
178            }
179        });
180    }
181}