Struct Builder

pub struct Builder<'a, T = (), V = BubbleSortValidator>
where
    V: MemoryReservationValidator,
{ /* private fields */ }

The FDT builder.

Uses the default BubbleSortValidator validator of the quadratic time complexity to validate memory reservations. That is suitable for the small number of memory reservations (say, up until ~8). Consider implementing your own validator if you expect a larger number of memory reservations.

Implementations

impl<'a, V> Builder<'a, (), V>

where V: MemoryReservationValidator,

pub fn new(_: BuilderConfig<'a>) -> Result<Self, Error>

Creates a new builder.

pub fn build(self, boot_cpuid_phys: u32) -> Result<usize, Error>

Finishes building the FDT blob. Returns the number of bytes used.

impl<'a, T> Builder<'a, T>

pub fn start_node(self, name: &str) -> Result<Builder<'a, Nest<T>>, Error>

Starts a new child node.

pub fn add_string(&mut self, s: &str) -> Result<StringId, Error>

Adds a string to the string table.

impl<'a, T> Builder<'a, Nest<T>>

pub fn add_null(self, name: StringId) -> Result<Self, Error>

Adds a property that does not have a value.

pub fn add_u32(self, name: StringId, data: u32) -> Result<Self, Error>

Adds a u32 property.

pub fn add_u64(self, name: StringId, data: u64) -> Result<Self, Error>

Adds a u64 property.

pub fn add_u64_array(self, name: StringId, data: &[u64]) -> Result<Self, Error>

Adds an array of u64 properties. Useful for reg or ranges.

pub fn add_u64_list( self, name: StringId, data: impl IntoIterator<Item = u64>, ) -> Result<Self, Error>

Adds a list of u64 properties. Useful for reg or ranges.

pub fn add_u32_array(self, name: StringId, data: &[u32]) -> Result<Self, Error>

Adds an array of u32 properties.

pub fn add_prop_array( self, name: StringId, data_array: &[&[u8]], ) -> Result<Self, Error>

Adds an array of properties. The caller must ensure these are Big Endian slices.

pub fn add_str(self, name: StringId, data: &str) -> Result<Self, Error>

Adds a string property.

pub fn add_str_array( self, name: StringId, strings: &[&str], ) -> Result<Self, Error>

Adds a string list property.

pub fn end_node(self) -> Result<Builder<'a, T>, Error>

Ends this node.