Enum BootloaderSpec

pub enum BootloaderSpec {
    Script {
        name: String,
    },
    FlashPartition {
        path: PathBuf,
        partition: u64,
    },
    FlashOffset {
        path: PathBuf,
        offset: u64,
    },
}

Specifies how to apply a bootloader image (file) to the target image.

You can write a file (inside the target filesystem) to a specific partition, or to a specific location (offset) of the target image, or use a script to finish this step.

Multiple entries are allowed, thus you can flash multiple files and run different scripts. The list will be executed sequencially.

Usage

In your device.toml, add one or more of the [[bootloader]] list items. Examples of [[bootloader]] entries are shown below:

Run a script within the same directory as device.toml

The script must present within the same directory of the device specification file, for example:

device1/
    apply-bootloader.sh
    device.toml
    postinst.sh

Defined variables are available for all bootloader scripts.

[[bootloader]]
type = script
# Path to the script file.
# This file must reside in the same directory as the device.toml file.
name = apply-bootloader.sh

Flash a bootloader image to the specific partition of the target image

[[bootloader]]
type = flash_partition
# Path to the bootloader image within the target root filesystem (symbolic links allowed).
path = "/usr/lib/u-boot/rk64/rk3588-orange-pi-5-max-idbloader.img"
# The index of the target partition
partition = 1

[[bootloader]]
type = flash_partition
# Path to the bootloader image within the target root filesystem (symbolic links allowed).
path = "/usr/lib/u-boot/rk64/rk3588-orange-pi-5-max.itb"
partition = 2

Flash a bootloader image to the specific location of the target image

The offset is not checked for overlaps of the partition/filesystem. Use it at your own risk.

[[bootloader]]
type = flash_offset
path = "/path/to/bootlodaer/image"
# Offset from the start of the target image in bytes.
offset = 0x400

Variants

Script

Run the script within the same directory as device.toml.

The script will be copied to a temporary location in the target filesystem. The script has access to all of the exported partition information.

[[bootloader]]
type = script
# Path to the script file.
# This file must reside in the same directory as the device.toml file.
name = apply-bootloader.sh

Fields

name: String

FlashPartition

Flash a bootloader image to the specific partition of the target image.

The path must be (or point to) a regular file within the target root filesystem.

[[bootloader]]
type = flash_partition
# Path to the bootloader image within the target root filesystem (symbolic links allowed).
path = "/usr/lib/u-boot/rk64/rk3588-orange-pi-5-max-idbloader.img"
# The index of the target partition
partition = 1

Fields

path: PathBuf

partition: u64

FlashOffset

Flash a bootloader image to the specific location of the target image.

The path must be (or point to) a regular file within the target root filesystem.

• Always make sure the image will not overlap existing partitions and filesystems.
• If your bootloader image is too large (e.g. exceeds 960KiB), you must adjust the starting position of the first partition (since the default starting sector is 2048 (1 MiB)).
• Therefore it is advised to create dedicated partitions reserved for bootloaders and flash them to their specific partition.

[[bootloader]]
type = flash_offset
path = "/path/to/bootlodaer/image"
# Offset from the start of the target image in bytes.
offset = 0x400

Fields

path: PathBuf

offset: u64

Implementations

impl BootloaderSpec

fn run_script<P, Q>(container: P, script: Q, binds: &[&str]) -> Result<()>

where P: AsRef<Path>, Q: AsRef<Path>,

fn apply_offset<P, Q, R>( img: P, offset: u64, container: Q, loopdev: R, ) -> Result<()>

where P: AsRef<Path>, Q: AsRef<Path>, R: AsRef<Path>,

fn apply_to_partition<P, Q, R>(img: P, container: Q, partition: R) -> Result<()>

where P: AsRef<Path>, Q: AsRef<Path>, R: AsRef<Path>,

Trait Implementations

impl Clone for BootloaderSpec

fn clone(&self) -> BootloaderSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BootloaderSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BootloaderSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BootloaderSpec

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

impl StructuralPartialEq for BootloaderSpec