wincwifi 0.3.0

WINC1500 Wifi chip embedded driver
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
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
139
140
141
142
143
144

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::readwrite::{BufferOverflow, ReadExactError};

/// Low-level chip communication errors
#[derive(Debug, PartialEq)]
pub enum CommError {
    Failed,
    BufferError,
    // From where, which byte, expected, actual
    ProtocolByteError(&'static str, usize, u8, u8),
    ReadError,
    WriteError,
    BufferReadError,
    UnexpectedAddressFamily, // AF wasn't set to AF_INET in response,
    Utf8Error(core::str::Utf8Error),
    CapacityError(arrayvec::CapacityError),
    /// Wifi module boot rom start failed
    BootRomStart,
    /// Wifi module firmware failed to start
    FirmwareStart,
    /// HIF send failed
    HifSendFailed,
    /// Invalid HiF response
    InvalidHifResponse(&'static str),
    /// Operation retries exceeded
    OperationRetriesExceeded,
    /// Specified exceeds the flash page.
    ExceedsFlashPageSize,
}

impl From<core::convert::Infallible> for CommError {
    fn from(_: core::convert::Infallible) -> Self {
        unreachable!("Infallible error")
    }
}

impl From<core::str::Utf8Error> for CommError {
    fn from(v: core::str::Utf8Error) -> Self {
        Self::Utf8Error(v)
    }
}

impl From<arrayvec::CapacityError> for CommError {
    fn from(v: arrayvec::CapacityError) -> Self {
        Self::CapacityError(v)
    }
}

impl From<BufferOverflow> for CommError {
    fn from(_: BufferOverflow) -> Self {
        CommError::BufferError
    }
}

impl<T> From<ReadExactError<T>> for CommError {
    fn from(_: ReadExactError<T>) -> Self {
        CommError::BufferReadError
    }
}

impl core::fmt::Display for CommError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let msg = match self {
            Self::Failed => "Operation failed",
            Self::BufferError => "Buffer error",
            Self::ProtocolByteError(loc, byte, expected, actual) => {
                return write!(
                    f,
                    "Protocol byte error at {}, byte {}: expected {:#x}, got {:#x}",
                    loc, byte, expected, actual
                );
            }
            Self::ReadError => "Read error",
            Self::WriteError => "Write error",
            Self::BufferReadError => "Buffer read error",
            Self::UnexpectedAddressFamily => "Unexpected address family",
            Self::Utf8Error(err) => return write!(f, "UTF-8 error: {}", err),
            Self::CapacityError(err) => return write!(f, "Capacity error: {}", err),
            Self::BootRomStart => "WiFi module boot ROM start failed",
            Self::FirmwareStart => "WiFi module firmware start failed",
            Self::HifSendFailed => "HIF send failed",
            Self::InvalidHifResponse(err_str) => {
                return write!(f, "Invalid {} response received.", err_str)
            }
            Self::OperationRetriesExceeded => "Operation retry limit exceeded.",
            Self::ExceedsFlashPageSize => "The provided length exceeds the flash page size.",
        };
        f.write_str(msg)
    }
}

#[cfg(feature = "defmt")]
impl defmt::Format for CommError {
    fn format(&self, f: defmt::Formatter) {
        match self {
            Self::Failed => defmt::write!(f, "Operation failed"),
            Self::BufferError => defmt::write!(f, "Buffer error"),
            Self::ProtocolByteError(loc, byte, expected, actual) => {
                defmt::write!(
                    f,
                    "Protocol byte error at {}, byte {}: expected {:#x}, got {:#x}",
                    loc,
                    byte,
                    expected,
                    actual
                );
            }
            Self::ReadError => defmt::write!(f, "Read error"),
            Self::WriteError => defmt::write!(f, "Write error"),
            Self::BufferReadError => defmt::write!(f, "Buffer read error"),
            Self::UnexpectedAddressFamily => defmt::write!(f, "Unexpected address family"),
            Self::Utf8Error(err) => defmt::write!(
                f,
                "UTF-8 error: invalid sequence at position {}, error length: {:?}",
                err.valid_up_to(),
                err.error_len()
            ),
            Self::CapacityError(_) => defmt::write!(f, "Capacity error: array full"),
            Self::BootRomStart => defmt::write!(f, "WiFi module boot ROM start failed"),
            Self::FirmwareStart => defmt::write!(f, "WiFi module firmware start failed"),
            Self::HifSendFailed => defmt::write!(f, "HIF send failed"),
            Self::InvalidHifResponse(err_str) => {
                defmt::write!(f, "Invalid {} response received.", err_str)
            }
            Self::ExceedsFlashPageSize => {
                defmt::write!(f, "The provided length exceeds the flash page size.")
            }
            Self::OperationRetriesExceeded => defmt::write!(f, "Operation retry limit exceeded."),
        }
    }
}