Enum BootMode

Source

#[repr(u32)]pub enum BootMode {
    BootWithFullConfiguration = 0,
    BootWithMinimalConfiguration = 1,
    BootAssumingNoConfigurationChanges = 2,
    BootWithFullConfigurationPlusDiagnostic = 3,
    BootWithDefaultSettings = 4,
    BootOnS4Resume = 5,
    BootOnS5Resume = 6,
    BootWithMfgModeSettings = 7,
    BootOnS2Resume = 16,
    BootOnS3Resume = 17,
    BootOnFlashUpdate = 18,
    BootInRecoveryMode = 32,
}

Expand description

§Boot Mode

The system boot mode indicates the “mode” in which the system is booting. The boot mode concept allows the firmware to accommodate system initialization specific to a given set of circumstances represented by the boot mode. It is a single value set in the HOB producer phase (e.g. PEI) and passed to the DXE phase via the Phase Handoff Information Table (PHIT) HOB. During the HOB producer phase, various modules may modify the boot mode until it settles upon a final value before being passed to the DXE phase.

§References

See PI Spec 1.8A - Defined Boot Modes
See PI SPec 1.8A - PHIT HOB

§Example

use patina::pi::BootMode;

let boot_mode = BootMode::BootWithFullConfiguration;
println!("Boot Mode: {}", boot_mode);

§Note

All targets currently assume that that the boot mode is represented as a u32

Variants§

§

BootWithFullConfiguration = 0

The basic S0 boot path. Informs all PEIMs to do a full configuration. The basic S0 boot path must be supported.

§

BootWithMinimalConfiguration = 1

A variation on the basic S0 boot path. Indicates that the minimal amount of hardware should be initialized to boot the system.

§

BootAssumingNoConfigurationChanges = 2

A variation on the basic S0 boot path. Indicates that the configuration data from the last boot should be used without any changes.

§

BootWithFullConfigurationPlusDiagnostic = 3

A variation on the basic S0 boot path. Indicates that the any diagnostic code should be run.

§

BootWithDefaultSettings = 4

A variation on the basic S0 boot path. Indicates that a known set of safe values for programming hardware should be used.

§

BootOnS4Resume = 5

The current boot is a S4 (Save to Disk) hibernate resume.

§

BootOnS5Resume = 6

The current boot is a S5 (Soft Off) power on. Some platforms may use this mode to differentiate between a normal for example, if buttons other than the power button can wake the system.

§

BootWithMfgModeSettings = 7

The current boot is a manufacturing mode boot. Firmware drivers may parameterize actions based on this mode that should only occur in a factory or a manufacturing environment.

§

BootOnS2Resume = 16

The boot is a S2 (Sleep) resume boot.

§

BootOnS3Resume = 17

The boot is a S3 (Save to RAM) resume boot. Platforms that support S3 resume must take special care to preserve/restore memory and critical hardware

§

BootOnFlashUpdate = 18

This boot mode can be either an INIT, S3, or other means by which to restart the machine. If it is an S3, for example, the flash update cause will supersede the S3 restart. It is incumbent upon platform code, such as the Memory Initialization PEIM, to determine the exact cause and perform correct behavior (i.e., S3 state restoration versus INIT behavior).

§

BootInRecoveryMode = 32

The boot is in recovery mode. This mode is used to recover from a previous boot failure.

Enum BootMode Copy item path

§Boot Mode

§References

§Example

§Note

Variants§

BootWithFullConfiguration = 0

BootWithMinimalConfiguration = 1

BootAssumingNoConfigurationChanges = 2

BootWithFullConfigurationPlusDiagnostic = 3

BootWithDefaultSettings = 4

BootOnS4Resume = 5

BootOnS5Resume = 6

BootWithMfgModeSettings = 7

BootOnS2Resume = 16

BootOnS3Resume = 17

BootOnFlashUpdate = 18

BootInRecoveryMode = 32

Trait Implementations§

impl Clone for Mode

fn clone(&self) -> Mode

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

impl Debug for Mode

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

impl Display for Mode

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

impl PartialEq for Mode

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

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

impl TryFrom<u32> for Mode

type Error = ()

fn try_from(value: u32) -> Result<Self, Self::Error>

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode

Auto Trait Implementations§

impl Freeze for Mode

impl RefUnwindSafe for Mode

impl Send for Mode

impl Sync for Mode

impl Unpin for Mode

impl UnsafeUnpin for Mode

impl UnwindSafe for Mode

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> Conv for T

fn conv<T>(self) -> Twhere Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pipe for Twhere T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Enum BootMode

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

fn conv<T>(self) -> T
where Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

impl<T> ToString for T
where T: Display + ?Sized,

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,