sdmmc-core 0.5.0

SD/MMC core data structures and algorithms
Documentation 
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

/// Represents the operation  modes of an SD card.
#[repr(C)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum OperationMode {
    Inactive,
    CardIdentification,
    DataTransfer,
}

impl OperationMode {
    /// Creates a new [OperationMode].
    pub const fn new() -> Self {
        Self::Inactive
    }
}

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

/// Represents the card states of an SD card.
#[repr(C)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum CardState {
    Inactive,
    Idle,
    Ready,
    Identification,
    Standby,
    Transfer,
    SendingData,
    ReceivingData,
    Programming,
    Disconnect,
}

impl CardState {
    /// Creates a new [CardState].
    pub const fn new() -> Self {
        Self::Inactive
    }

    /// Gets the [OperationMode] associated with the [CardState].
    ///
    /// For details, see `Table 4-1` of [Part1 Physical Layer](https://www.sdcard.org/downloads/pls/pdf/?f=Part1PhysicalLayerSimplifiedSpecificationVer9.10Fin_20231201.pdf) SD specification.
    pub const fn operation_mode(&self) -> OperationMode {
        match self {
            Self::Inactive => OperationMode::Inactive,
            Self::Idle | Self::Ready | Self::Identification => OperationMode::CardIdentification,
            _ => OperationMode::DataTransfer,
        }
    }
}

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

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

    #[test]
    fn test_card_state() {
        [
            CardState::Inactive,
            CardState::Idle,
            CardState::Ready,
            CardState::Identification,
            CardState::Standby,
            CardState::Transfer,
            CardState::SendingData,
            CardState::ReceivingData,
            CardState::Programming,
            CardState::Disconnect,
        ]
        .into_iter()
        .zip([
            OperationMode::Inactive,
            OperationMode::CardIdentification,
            OperationMode::CardIdentification,
            OperationMode::CardIdentification,
            OperationMode::DataTransfer,
            OperationMode::DataTransfer,
            OperationMode::DataTransfer,
            OperationMode::DataTransfer,
            OperationMode::DataTransfer,
            OperationMode::DataTransfer,
        ])
        .for_each(|(exp_cs, exp_om)| {
            assert_eq!(
                exp_cs.operation_mode(),
                exp_om,
                "CardState: {exp_cs:?}, OperationMode: {exp_om:?}"
            );
        });
    }
}