aic8800 0.3.0

OS-independent AIC8800 Wi-Fi driver core
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

//! Firmware-assigned link identities and their validity invariants.

use crate::device::AicError;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(transparent)]
pub(super) struct InterfaceIndex(u8);

impl InterfaceIndex {
    pub(super) fn from_firmware(value: u8) -> Result<Self, AicError> {
        (value != u8::MAX)
            .then_some(Self(value))
            .ok_or(AicError::MalformedResponse)
    }

    pub(super) const fn get(self) -> u8 {
        self.0
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(transparent)]
pub(super) struct StationIndex(u8);

impl StationIndex {
    pub(super) fn from_firmware(value: u8) -> Result<Self, AicError> {
        (value != u8::MAX)
            .then_some(Self(value))
            .ok_or(AicError::MalformedResponse)
    }

    pub(super) const fn get(self) -> u8 {
        self.0
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) struct LinkState {
    mac_address: Option<[u8; 6]>,
    interface: Option<InterfaceIndex>,
    peer: Option<(StationIndex, [u8; 6])>,
    control_port_open: bool,
}

impl LinkState {
    pub(super) const fn new() -> Self {
        Self {
            mac_address: None,
            interface: None,
            peer: None,
            control_port_open: false,
        }
    }

    pub(super) fn install_mac(&mut self, mac: [u8; 6]) -> Result<(), AicError> {
        let multicast = mac[0] & 1 != 0;
        if mac == [0; 6] || multicast {
            return Err(AicError::InvalidMacAddress);
        }
        self.mac_address = Some(mac);
        Ok(())
    }

    pub(super) const fn mac_address(&self) -> Option<[u8; 6]> {
        self.mac_address
    }

    pub(super) fn install_interface(&mut self, index: u8) -> Result<(), AicError> {
        self.interface = Some(InterfaceIndex::from_firmware(index)?);
        self.clear_peer();
        Ok(())
    }

    pub(super) fn install_peer(
        &mut self,
        interface: u8,
        station: u8,
        bssid: [u8; 6],
    ) -> Result<(), AicError> {
        let expected = self.interface.ok_or(AicError::MalformedResponse)?;
        let actual = InterfaceIndex::from_firmware(interface)?;
        if actual != expected || bssid == [0; 6] || bssid[0] & 1 != 0 {
            return Err(AicError::MalformedResponse);
        }
        self.peer = Some((StationIndex::from_firmware(station)?, bssid));
        self.control_port_open = false;
        Ok(())
    }

    pub(super) const fn tx_indices(&self) -> Option<(u8, u8)> {
        match (self.interface, self.peer) {
            (Some(interface), Some((station, _))) => Some((interface.get(), station.get())),
            _ => None,
        }
    }

    pub(super) const fn interface_index(&self) -> Option<u8> {
        match self.interface {
            Some(index) => Some(index.get()),
            None => None,
        }
    }

    pub(super) const fn peer(&self) -> Option<(u8, [u8; 6])> {
        match self.peer {
            Some((index, bssid)) => Some((index.get(), bssid)),
            None => None,
        }
    }

    pub(super) fn open_control_port(&mut self) -> Result<(), AicError> {
        if self.peer.is_none() {
            return Err(AicError::MalformedResponse);
        }
        self.control_port_open = true;
        Ok(())
    }

    pub(super) fn clear_peer(&mut self) {
        self.peer = None;
        self.control_port_open = false;
    }
}

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

    #[test]
    fn rejects_zero_and_multicast_mac_addresses() {
        let mut link = LinkState::new();
        assert_eq!(link.install_mac([0; 6]), Err(AicError::InvalidMacAddress));
        assert_eq!(
            link.install_mac([1, 0, 0, 0, 0, 1]),
            Err(AicError::InvalidMacAddress)
        );
    }
}