Struct HeaderV0 

pub struct HeaderV0 {

    pub kernel_size: u32,
    pub kernel_addr: u32,
    pub ramdisk_size: u32,
    pub ramdisk_addr: u32,
    pub second_bootloader_size: u32,
    pub second_bootloader_addr: u32,
    pub tags_addr: u32,
    pub page_size: u32,
    pub osversionpatch: OsVersionPatch,
    pub board_name: [u8; 16],
    pub hash_digest: [u8; 32],
    pub cmdline: Box<[u8; 1536]>,
    pub versioned: HeaderV0Versioned,
}

Standard Android boot image header versions 0, 1 and 2

Section layout in the image

Sections after the header are marked by fields of the form *_size, and are stored consecutively, padded to page size.

Sections in HeaderV0 are also marked with the physical address where a bootloader should load them to.

┌─────────────────────────┐
│boot image header        │
│+ padding to page size   │
├─────────────────────────┤
│kernel                   │
│+ padding to page size   │
├─────────────────────────┤
│ramdisk                  │
│+ padding to page size   │
├─────────────────────────┤
│second stage bootloader  │
│+ padding to page size   │
├─────────────────────────┤
│recovery dtbo/acpio (v1+)│
│+ padding to page size   │
├─────────────────────────┤
│dtb (v2)                 │
│+ padding to page size   │
└─────────────────────────┘

Additional Documentation

• https://source.android.com/docs/core/architecture/bootloader/boot-image-header
• https://docs.u-boot.org/en/latest/android/boot-image.html

Fields

kernel_size: u32

Kernel size

kernel_addr: u32

Kernel physical load address

ramdisk_size: u32

Ramdisk size

ramdisk_addr: u32

Ramdisk physical load address

second_bootloader_size: u32

Second bootloader size

second_bootloader_addr: u32

Second bootloader physical load address

tags_addr: u32

Kernel tags physical load address

page_size: u32

Page size in bytes

osversionpatch: OsVersionPatch

OS version and patch level

board_name: [u8; 16]

Board or product name

hash_digest: [u8; 32]

Hash digest

Usually either a SHA1 (20 bytes of digest, 12 null-bytes) or a SHA256 (32 bytes of digest) digest of the following: kernel, ramdisk, second bootloader, recovery DTBO and DTB.

• If the size is nonzero, hash the contents.
• Update the hash with the little-endian representation of the 32-bit unsigned size (u32::to_le_bytes), which may be zero.

cmdline: Box<[u8; 1536]>

Kernel command line

versioned: HeaderV0Versioned

Version-specific part of the boot image header.

Implementations

impl HeaderV0

pub const fn header_version(&self) -> u32

Returns the boot image header’s version number.

pub const fn kernel_position(&self) -> usize

Returns the kernel’s position in the boot image.

pub const fn ramdisk_position(&self) -> usize

Returns the ramdisk’s position in the boot image.

pub const fn second_bootloader_position(&self) -> usize

Returns the second stage bootloader’s position in the boot image.

pub const fn recovery_dtbo_position(&self) -> usize

Returns the recovery DTBO’s position in the boot image.

pub const fn dtb_position(&self) -> Option<usize>

Returns the DTB’s position in the boot image.

This returns None in version 0.

Note that this section is undefined in version 1.

pub const fn boot_image_size(&self) -> usize

Returns the size of the boot image.

pub fn compute_hash_digest<R: Read, D: Digest>( kernel: Option<&mut R>, ramdisk: Option<&mut R>, second_bootloader: Option<&mut R>, recovery_dtbo: Option<&mut R>, dtb: Option<&mut R>, ) -> Result<[u8; 32]>

Available on crate feature hash only.

Finalizes the passed in hasher to create a Self::hash_digest.

Errors

Passes through errors that occur in the readers and errors when more than u32::MAX bytes were read from a single file.

Examples found in repository

examples/compute-hash-digest.rs (lines 40-46)

fn hash_files<D: digest::Digest>(files: [Option<&mut &File>; 5]) -> [u8; 32] {
    let [kernel_f, ramdisk_f, second_bootloader_f, recovery_dtbo_f, dtb_f] = files;

    HeaderV0::compute_hash_digest::<_, D>(
        kernel_f,
        ramdisk_f,
        second_bootloader_f,
        recovery_dtbo_f,
        dtb_f,
    )
    .unwrap()
}

pub fn full_write<W: Write + Seek, R: Read>( &self, writer: &mut W, kernel: Option<&mut R>, ramdisk: Option<&mut R>, second_bootloader: Option<&mut R>, recovery_dtbo: Option<&mut R>, dtb: Option<&mut R>, ) -> BinResult<()>

Available on crate feature std only.

Writes the full Android boot image, including the different parts after the header.

• Requires the Rust standard library for std::io::copy.
• Assumes that the readers will output exact amounts. That is, kernel will only ever output exactly Self::kernel_size bytes.

Errors

Passes through errors that occur in the readers or the writer or during serialization of the header.

Trait Implementations

impl BinRead for HeaderV0

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl BinWrite for HeaderV0

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl Clone for HeaderV0

fn clone(&self) -> HeaderV0

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderV0

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

Formats the value using the given formatter.

impl Hash for HeaderV0

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HeaderV0

fn eq(&self, other: &HeaderV0) -> 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 ReadEndian for HeaderV0

const ENDIAN: EndianKind

The endianness of the type.

impl ReadMagic for HeaderV0

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 8]

The type of the magic number.

impl WriteEndian for HeaderV0

const ENDIAN: EndianKind

The endianness of the type.

impl WriteMagic for HeaderV0

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 8]

The type of the magic number.

impl Eq for HeaderV0

impl StructuralPartialEq for HeaderV0