Struct DevTree

pub struct DevTree<'dt> { /* private fields */ }

A parseable Flattened Device Tree.

This parser was written according to the v0.3 specification provided at https://www.devicetree.org/

Implementations

impl<'dt> DevTree<'dt>

pub const MIN_HEADER_SIZE: usize = 40usize

pub unsafe fn verify_magic(buf: &[u8]) -> Result<()>

Verify the magic header of a Device Tree buffer

Safety

Callers of this method the must guarantee the following:

• The passed buffer is 32-bit aligned.

The passed byte buffer will be interpreted as a Flattened Device Tree. For this reason this API is marked unsafe.

pub unsafe fn read_totalsize(buf: &[u8]) -> Result<usize>

Using the provided byte slice this method will:

1. Verify that the slice begins with the magic Device Tree header
2. Return the reported totalsize field of the Device Tree header

When parsing a FDT, it’s possible that the actual size of the device tree may be unknown. For that reason, this method can be called before constructing the DevTree. For this read to take place, the provided buffer must be at least Self::MIN_HEADER_SIZE long.

Once known, the user should resize the raw byte slice to this function’s return value and pass that slice to DevTree::new().

Example

TODO

Safety

Callers of this method the must guarantee the following:

• The passed buffer is 32-bit aligned.
• The passed buffer is of at least DevTree::MIN_HEADER_SIZE bytes in length

The passed byte buffer will be interpreted as a Flattened Device Tree. For this reason this API is marked unsafe.

pub unsafe fn new(buf: &'dt [u8]) -> Result<Self>

Construct the parseable DevTree object from the provided byte slice.

Safety

Callers of this method the must guarantee the following:

• The passed buffer is 32-bit aligned.
• The passed buffer is exactly the length returned by Self::read_totalsize()

pub unsafe fn from_raw_pointer(addr: *const u8) -> Result<Self>

Construct the parseable DevTree object from a raw byte pointer

Safety

Callers of this method the must guarantee the following:

• The passed address is 32-bit aligned.

pub fn totalsize(&self) -> usize

Returns the totalsize field of the Device Tree. This is the number of bytes of the device tree structure.

pub fn off_mem_rsvmap(&self) -> usize

Returns the rsvmap offset field of the Device Tree

pub fn off_dt_struct(&self) -> usize

Returns the dt_struct offset field of the Device Tree

pub fn off_dt_strings(&self) -> usize

Returns the dt_strings offset field of the Device Tree

pub fn magic(&self) -> u32

Returns the magic field of the Device Tree

pub fn version(&self) -> u32

Returns the version field of the Device Tree

pub fn boot_cpuid_phys(&self) -> u32

Returns the boot_cpuid_phys field of the Device Tree

pub fn last_comp_version(&self) -> u32

Returns the last_comp_version field of the Device Tree

pub fn size_dt_strings(&self) -> u32

Returns the size_dt_strings field of the Device Tree

pub fn size_dt_struct(&self) -> u32

Returns the size_dt_struct field of the Device Tree

pub fn reserved_entries(&self) -> DevTreeReserveEntryIter<'_, '_>

Returns an iterator over the Dev Tree “5.3 Memory Reservation Blocks”

pub fn nodes(&self) -> DevTreeNodeIter<'_, 'dt>

Returns an iterator over DevTreeNode objects

pub fn props(&self) -> DevTreePropIter<'_, 'dt>

pub fn items(&self) -> DevTreeIter<'_, 'dt>

Returns an iterator over objects within the DevTreeItem enum

pub fn parse_iter(&self) -> DevTreeParseIter<'_, 'dt>

Returns an iterator over low level parsing tokens, ParsedTok.

pub fn compatible_nodes<'s, 'a: 's>( &'a self, string: &'s str, ) -> DevTreeCompatibleNodeIter<'s, 'a, 'dt>

Returns the first DevTreeNode object with the provided compatible device tree property or None if none exists.

pub fn buf(&self) -> &'dt [u8]

pub fn root(&self) -> Result<Option<DevTreeNode<'_, 'dt>>>

Returns the root DevTreeNode object of the device tree (if it exists).

Trait Implementations

impl<'dt> Clone for DevTree<'dt>

fn clone(&self) -> DevTree<'dt>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'dt> Debug for DevTree<'dt>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'dt> PartialEq for DevTree<'dt>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'dt> Copy for DevTree<'dt>