aic8800 0.3.2

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

use crate::{
    common::{SDIOWIFI_REGISTER_BLOCK, SDIOWIFI_V3_WAKEUP_VALUE},
    device::*,
    registers::INTERRUPTS_ENABLED,
};

impl AicDevice {
    pub(super) fn vendor_setup_operation(
        &self,
        index: u8,
        reinitialize: bool,
    ) -> Option<SdioRequestKind> {
        if self.transport_generation() == crate::profile::TransportGeneration::V3 {
            match index {
                0 => Some(write_byte(0, 0xf2, 0x7f)),
                1 => Some(write_byte(1, self.registers().byte_mode_enable, 1)),
                2 => Some(write_byte(
                    1,
                    self.registers()
                        .wakeup
                        .expect("v3 chips define a wakeup register"),
                    SDIOWIFI_V3_WAKEUP_VALUE,
                )),
                3 if reinitialize => Some(write_byte(0, 0x04, INTERRUPTS_ENABLED)),
                3 => Some(write_byte(
                    1,
                    self.registers().interrupt_enable,
                    INTERRUPTS_ENABLED,
                )),
                _ => None,
            }
        } else {
            match index {
                0 => Some(write_byte(1, SDIOWIFI_REGISTER_BLOCK, 1)),
                1 => Some(write_byte(1, self.registers().byte_mode_enable, 1)),
                2 => Some(write_byte(2, SDIOWIFI_REGISTER_BLOCK, 1)),
                3 => Some(write_byte(2, self.registers().byte_mode_enable, 1)),
                4 => Some(write_byte(
                    1,
                    self.registers().interrupt_enable,
                    INTERRUPTS_ENABLED,
                )),
                5 => Some(write_byte(
                    2,
                    self.registers().interrupt_enable,
                    INTERRUPTS_ENABLED,
                )),
                _ => None,
            }
        }
    }

    pub(super) fn validate_vendor_setup_readback(
        &self,
        index: u8,
        reinitialize: bool,
        response: SdioResponse,
    ) -> Result<(), AicError> {
        let Some(SdioRequestKind::WriteByte { value, .. }) =
            self.vendor_setup_operation(index, reinitialize)
        else {
            return Err(AicError::CompletionMismatch);
        };
        // V3 wakeup and interrupt-enable writes can return the previous byte.
        // Check transport completion here; VendorReady independently checks
        // wakeup readiness. CCCR and ordinary configuration retain echo checks.
        if self.transport_generation() == crate::profile::TransportGeneration::V3
            && (index == 2 || (index == 3 && !reinitialize))
        {
            expect_byte(response)?;
            return Ok(());
        }
        expect_write_readback(response, value)
    }
}

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

    #[test]
    fn v3_wakeup_write_accepts_a_non_echoing_read_back_byte() {
        let device = AicDevice::new(ChipVariant::Aic8800D80).unwrap();

        for reinitialize in [false, true] {
            assert_eq!(
                device.validate_vendor_setup_readback(2, reinitialize, SdioResponse::Byte(0x01)),
                Ok(())
            );
        }
    }

    #[test]
    fn v3_vendor_writes_still_enforce_the_read_back_value() {
        let device = AicDevice::new(ChipVariant::Aic8800D80).unwrap();

        assert!(matches!(
            device.validate_vendor_setup_readback(0, false, SdioResponse::Byte(0x00)),
            Err(AicError::SdioWriteReadbackMismatch {
                expected: 0x7f,
                actual: 0x00
            })
        ));
    }

    #[test]
    fn v3_vendor_setup_arms_the_device_interrupt_before_the_rom_mailbox_phase() {
        let device = AicDevice::new(ChipVariant::Aic8800D80).unwrap();

        assert!(matches!(
            device.vendor_setup_operation(3, false),
            Some(SdioRequestKind::WriteByte {
                function,
                address,
                value: INTERRUPTS_ENABLED,
                ..
            }) if function.get() == 1
                && address.get() == device.registers().interrupt_enable
        ));
    }

    #[test]
    fn v3_rom_interrupt_arm_accepts_the_raw_read_back_byte() {
        let device = AicDevice::new(ChipVariant::Aic8800D80).unwrap();

        assert_eq!(
            device.validate_vendor_setup_readback(3, false, SdioResponse::Byte(0x00)),
            Ok(())
        );
    }
}