psi_device_tree 2.2.0

Reads and parses Linux device tree images
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

/// Convenience alias for the [`Result`](core::result::Result) type.
pub type Result<T> = core::result::Result<T, Error>;

pub type SliceReadResult<T> = core::result::Result<T, SliceReadError>;

pub type VecWriteResult = core::result::Result<(), VecWriteError>;

/// An error describe parsing problems when creating device trees.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Error {
    /// The magic number `MAGIC_NUMBER` was not found at the start of the
    /// structure.
    InvalidMagicNumber,

    /// An offset or size found inside the device tree is outside of what was
    /// supplied to `load()`.
    SizeMismatch,

    /// Failed to read data from slice.
    SliceReadError(SliceReadError),

    /// The data format was not as expected at the given position
    ParseError(usize),

    /// While trying to convert a string that was supposed to be ASCII, invalid
    /// utf8 sequences were encounted
    Utf8Error,

    /// The device tree version is not supported by this library.
    VersionNotSupported,

    /// The device tree structure could not be serialized to DTB
    VecWriteError(VecWriteError),

    /// Property could not be parsed
    PropError(PropError),
}

impl From<SliceReadError> for Error {
    fn from(e: SliceReadError) -> Error {
        Error::SliceReadError(e)
    }
}

impl From<VecWriteError> for Error {
    fn from(e: VecWriteError) -> Error {
        Error::VecWriteError(e)
    }
}

impl From<PropError> for Error {
    fn from(e: PropError) -> Self {
        Self::PropError(e)
    }
}

impl From<core::str::Utf8Error> for Error {
    fn from(_: core::str::Utf8Error) -> Error {
        Error::Utf8Error
    }
}

/// Represents property errors.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum PropError {
    NotFound,
    Utf8Error,
    Missing0,
    SliceReadError(SliceReadError),
}

impl From<core::str::Utf8Error> for PropError {
    fn from(_: core::str::Utf8Error) -> PropError {
        PropError::Utf8Error
    }
}

impl From<SliceReadError> for PropError {
    fn from(e: SliceReadError) -> PropError {
        PropError::SliceReadError(e)
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum SliceReadError {
    UnexpectedEndOfInput,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum VecWriteError {
    NonContiguousWrite,
    UnalignedWrite,
}