punt 0.3.1

A library to connect to the punt STM32 USB bootloader
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

use std::error::Error as StdError;
use std::fmt::{Display, Formatter};
use std::result::Result as StdResult;

/// Errors which can occur during target setup and communication.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum Error {
    /// An operation could not be performed because it was prohibited by safety checks (e.g.
    /// programming at an odd address)
    InvalidRequest,

    /// It was attempted to open a connection to a target which does not exist.
    TargetNotFound,

    /// The given USB address pertains to an unsupported USB device (probably not even a punt
    /// bootloader).
    UnsupportedTarget,

    /// The request was not specific enough and returned in multiple matches where only a single one
    /// is supported.
    TooManyMatches,

    /// An error was reported during the erase from the target.
    EraseError(EraseError),

    /// Verifying memory contents via CRC failed.
    VerificationError,

    /// An error occurred during the raw USB communication.
    IoError(rusb::Error),

    /// The target responded with unexpected data.
    MalformedResponse,
}

impl StdError for Error {}

impl Display for Error {
    fn fmt(&self, fmt: &mut Formatter) -> StdResult<(), std::fmt::Error> {
        if let Error::IoError(err) = self {
            write!(fmt, "IO Error: {}", err)
        } else {
            fmt.write_str(match self {
                Error::InvalidRequest => "Invalid request.",
                Error::TargetNotFound => "Target not found",
                Error::UnsupportedTarget => "Target is unsupported",
                Error::TooManyMatches => "Too many matches",
                Error::EraseError(_) => "Flash erase error",
                Error::VerificationError => "Verification error",
                Error::MalformedResponse => "Malformed response",
                Error::IoError(_) => unreachable!(),
            })
        }
    }
}

impl From<rusb::Error> for Error {
    fn from(error: rusb::Error) -> Self {
        Error::IoError(error)
    }
}

/// Error during flash erasing.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum EraseError {
    /// Erasing an area which should or could not be erased was attempted.
    Prohibited = 1,

    /// No problems during erasing, but the area turned out to be actually not erased.
    VerifyFailed = 2,

    /// Used for all error codes the bootloader firmware does not use. Thus, it should never occur.
    Unknown,
}

impl From<u8> for EraseError {
    fn from(code: u8) -> EraseError {
        match code {
            c if c == EraseError::Prohibited as u8 => EraseError::Prohibited,
            c if c == EraseError::VerifyFailed as u8 => EraseError::VerifyFailed,
            _ => EraseError::Unknown,
        }
    }
}

/// Shorthand for a Result with the crate's own Error type.
pub type Result<T> = StdResult<T, Error>;