sdmmc-core 0.5.0

use crate::lib_bitfield;
use crate::result::{Error, Result};

mod sssf;

pub use sssf::*;

lib_bitfield! {
    /// Argumentument for CMD5.
    pub Argument(u32): u8 {
        raw_sp: 31, 24;
        raw_spsp1: 23, 16;
        raw_spsp0: 15, 8;
        raw_sssf: 7, 0;
    }
}

impl Argument {
    /// Represents the byte length of the [Argument].
    pub const LEN: usize = 4;
    /// Represents the raw default value of the [Argument].
    pub const DEFAULT: u32 = 1;

    /// Creates a new [Argument].
    pub const fn new() -> Self {
        Self(Self::DEFAULT)
    }

    /// Gets the `security protocol` field of the [Argument].
    pub const fn sp(&self) -> u8 {
        self.raw_sp()
    }

    /// Sets the `security protocol` field of the [Argument].
    pub fn set_sp(&mut self, val: u8) {
        self.set_raw_sp(val as u32);
    }

    /// Gets the `security protocol specific 1` field of the [Argument].
    pub const fn spsp1(&self) -> u8 {
        self.raw_spsp1()
    }

    /// Sets the `security protocol specific 1` field of the [Argument].
    pub fn set_spsp1(&mut self, val: u8) {
        self.set_raw_spsp1(val as u32);
    }

    /// Gets the `security protocol specific 0` field of the [Argument].
    pub const fn spsp0(&self) -> u8 {
        self.raw_spsp0()
    }

    /// Sets the `security protocol specific 0` field of the [Argument].
    pub fn set_spsp0(&mut self, val: u8) {
        self.set_raw_spsp0(val as u32);
    }

    /// Gets the `SD security specific field` field of the [Argument].
    pub const fn sssf(&self) -> Result<SdSecuritySpecificField> {
        SdSecuritySpecificField::from_raw(self.raw_sssf())
    }

    /// Sets the `SD security specific field` field of the [Argument].
    pub fn set_sssf(&mut self, val: SdSecuritySpecificField) {
        self.set_raw_sssf(val.into_raw() as u32);
    }

    /// Attempts to convert a [`u32`] into an [Argument].
    pub const fn try_from_bits(val: u32) -> Result<Self> {
        match Self(val) {
            acmd if acmd.sssf().is_err() => Err(Error::invalid_field_variant(
                "command::argument::sssf",
                acmd.raw_sssf() as usize,
            )),
            acmd => Ok(acmd),
        }
    }

    /// Converts the [Argument] into a byte array.
    pub const fn bytes(&self) -> [u8; Self::LEN] {
        self.0.to_be_bytes()
    }

    /// Attempts to convert a byte slice into an [Argument].
    pub const fn try_from_bytes(val: &[u8]) -> Result<Self> {
        match val.len() {
            len if len < Self::LEN => Err(Error::invalid_length(len, Self::LEN)),
            _ => Self::try_from_bits(u32::from_be_bytes([val[0], val[1], val[2], val[3]])),
        }
    }
}

impl Default for Argument {
    fn default() -> Self {
        Self::new()
    }
}

impl TryFrom<u32> for Argument {
    type Error = Error;

    fn try_from(val: u32) -> Result<Self> {
        Self::try_from_bits(val)
    }
}

impl From<Argument> for u32 {
    fn from(val: Argument) -> Self {
        val.bits()
    }
}

impl From<Argument> for [u8; Argument::LEN] {
    fn from(val: Argument) -> Self {
        val.bytes()
    }
}

impl TryFrom<&[u8]> for Argument {
    type Error = Error;

    fn try_from(val: &[u8]) -> Result<Self> {
        Self::try_from_bytes(val)
    }
}

impl<const N: usize> TryFrom<&[u8; N]> for Argument {
    type Error = Error;

    fn try_from(val: &[u8; N]) -> Result<Self> {
        Self::try_from_bytes(val.as_ref())
    }
}

impl<const N: usize> TryFrom<[u8; N]> for Argument {
    type Error = Error;

    fn try_from(val: [u8; N]) -> Result<Self> {
        Self::try_from_bytes(val.as_ref())
    }
}

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

    #[test]
    fn test_fields() {
        let new_sssf = SdSecuritySpecificField::new();
        let new_sp = 0;
        let new_spsp1 = 0;
        let new_spsp0 = 0;

        // test non-sssf fields with a fixed, valid sssf variant
        (8..=u32::BITS)
            .map(|r| (((1u64 << r) - 1) as u32) | 1)
            .for_each(|raw_arg| {
                let raw = raw_arg.to_be_bytes();
                let exp_sp = ((raw_arg & 0xff00_0000) >> 24) as u8;
                let exp_spsp1 = ((raw_arg & 0xff_0000) >> 16) as u8;
                let exp_spsp0 = ((raw_arg & 0xff00) >> 8) as u8;
                let raw_sssf = (raw_arg & 0xff) as u8;

                match Argument::try_from_bits(raw_arg) {
                    Ok(mut exp_arg) => {
                        let exp_sssf = SdSecuritySpecificField::from_raw(raw_sssf).unwrap();

                        assert_eq!(Argument::try_from_bits(raw_arg), Ok(exp_arg));
                        assert_eq!(Argument::try_from_bytes(&raw), Ok(exp_arg));
                        assert_eq!(Argument::try_from(raw_arg), Ok(exp_arg));
                        assert_eq!(Argument::try_from(raw), Ok(exp_arg));
                        assert_eq!(Argument::try_from(&raw), Ok(exp_arg));

                        assert_eq!(exp_arg.sp(), exp_sp);

                        exp_arg.set_sp(new_sp);
                        assert_eq!(exp_arg.sp(), new_sp);

                        exp_arg.set_sp(exp_sp);
                        assert_eq!(exp_arg.sp(), exp_sp);

                        assert_eq!(exp_arg.spsp1(), exp_spsp1);

                        exp_arg.set_spsp1(new_spsp1);
                        assert_eq!(exp_arg.spsp1(), new_spsp1);

                        exp_arg.set_spsp1(exp_spsp1);
                        assert_eq!(exp_arg.spsp1(), exp_spsp1);

                        assert_eq!(exp_arg.spsp0(), exp_spsp0);

                        exp_arg.set_spsp0(new_spsp0);
                        assert_eq!(exp_arg.spsp0(), new_spsp0);

                        exp_arg.set_spsp0(exp_spsp0);
                        assert_eq!(exp_arg.spsp0(), exp_spsp0);

                        assert_eq!(exp_arg.spsp0(), exp_spsp0);

                        exp_arg.set_sssf(new_sssf);
                        assert_eq!(exp_arg.sssf(), Ok(new_sssf));

                        exp_arg.set_sssf(exp_sssf);
                        assert_eq!(exp_arg.sssf(), Ok(exp_sssf));
                    }
                    Err(err) => {
                        let exp_err = Error::invalid_field_variant(
                            "command::argument::sssf",
                            raw_sssf as usize,
                        );
                        assert_eq!(err, exp_err);

                        assert_eq!(Argument::try_from_bits(raw_arg), Err(exp_err));
                        assert_eq!(Argument::try_from_bytes(&raw), Err(exp_err));
                        assert_eq!(Argument::try_from(raw_arg), Err(exp_err));
                        assert_eq!(Argument::try_from(raw), Err(exp_err));
                        assert_eq!(Argument::try_from(&raw), Err(exp_err));
                    }
                }
            });

        // test sssf variants
        (1..=8u32)
            .map(|r| ((1u64 << r) - 1) as u32)
            .for_each(|raw_arg| {
                let raw = raw_arg.to_be_bytes();
                let raw_sssf = (raw_arg & 0xff) as u8;

                match Argument::try_from_bits(raw_arg) {
                    Ok(mut exp_arg) => {
                        let exp_sssf = SdSecuritySpecificField::from_raw(raw_sssf).unwrap();

                        assert_eq!(Argument::try_from_bits(raw_arg), Ok(exp_arg));
                        assert_eq!(Argument::try_from_bytes(&raw), Ok(exp_arg));
                        assert_eq!(Argument::try_from(raw_arg), Ok(exp_arg));
                        assert_eq!(Argument::try_from(raw), Ok(exp_arg));
                        assert_eq!(Argument::try_from(&raw), Ok(exp_arg));

                        exp_arg.set_sssf(new_sssf);
                        assert_eq!(exp_arg.sssf(), Ok(new_sssf));

                        exp_arg.set_sssf(exp_sssf);
                        assert_eq!(exp_arg.sssf(), Ok(exp_sssf));
                    }
                    Err(err) => {
                        let exp_err = Error::invalid_field_variant(
                            "command::argument::sssf",
                            raw_sssf as usize,
                        );
                        assert_eq!(err, exp_err);

                        assert_eq!(Argument::try_from_bits(raw_arg), Err(exp_err));
                        assert_eq!(Argument::try_from_bytes(&raw), Err(exp_err));
                        assert_eq!(Argument::try_from(raw_arg), Err(exp_err));
                        assert_eq!(Argument::try_from(raw), Err(exp_err));
                        assert_eq!(Argument::try_from(&raw), Err(exp_err));
                    }
                }
            });
    }
}