Struct BootManagerProxy

pub struct BootManagerProxy { /* private fields */ }

Implementations

impl BootManagerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.paver/BootManager.

pub fn take_event_stream(&self) -> BootManagerEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn query_current_configuration( &self, ) -> QueryResponseFut<BootManagerQueryCurrentConfigurationResult, DefaultFuchsiaResourceDialect>

Queries the configuration the system is currently running.

Returns ZX_ERR_NOT_SUPPORTED if the zvb.current_slot boot argument cannot be read or is an unexpected value.

pub fn query_active_configuration( &self, ) -> QueryResponseFut<BootManagerQueryActiveConfigurationResult, DefaultFuchsiaResourceDialect>

Queries the configuration which will be used as the default boot choice on a normal cold boot, which may differ from the currently running configuration. Configuration::RECOVERY should never be active.

Returns ZX_ERR_NOT_SUPPORTED if Configuration.RECOVERY is active.

pub fn query_configuration_last_set_active( &self, ) -> QueryResponseFut<BootManagerQueryConfigurationLastSetActiveResult, DefaultFuchsiaResourceDialect>

Queries the configuration that was last explicitly marked as active by SetConfigurationActive(). The result is not affected by the current status of the slot.

A newly updated slot is typically marked as active immediately. Therefore this interface can be used as a way to identify the newest slot.

Returns ZX_ERR_IO if fail to load abr metadata. Returns ZX_ERR_INTERNAL if invalid slot index is returned by libabr routine.

pub fn query_configuration_status( &self, configuration: Configuration, ) -> QueryResponseFut<BootManagerQueryConfigurationStatusResult, DefaultFuchsiaResourceDialect>

Queries status of configuration.

Returns ZX_ERR_INVALID_ARGS if Configuration.RECOVERY is passed in via configuration.

pub fn query_configuration_status_and_boot_attempts( &self, configuration: Configuration, ) -> QueryResponseFut<BootManagerQueryConfigurationStatusAndBootAttemptsResult, DefaultFuchsiaResourceDialect>

Queries status of configuration.

The returned table contains:

• status: the current ConfigurationStatus

• boot_attempts: if status is ConfigurationStatus::PENDING, this will be the number of times this configuration has attempted to boot, including the current attempt. For any other status this value will not be provided.

  If provided, this value will be in the range [0, MAX_PENDING_BOOT_ATTEMPTS]. 0 indicates the configuration was just set active and has not attempted any boots yet, and MAX_PENDING_BOOT_ATTEMPTS indicates that all attempts have been used.

• unbootable_reason: if status is ConfigurationStatus::UNBOOTABLE, this will be the reported reason for why the configuration is unbootable. For any other status this value will not be provided.

Returns ZX_ERR_INVALID_ARGS if Configuration.RECOVERY is passed in via configuration.

pub fn set_configuration_active( &self, configuration: Configuration, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Updates persistent metadata identifying which configuration should be selected as ‘primary’ for booting purposes. Should only be called after KERNEL as well as optional VERIFIED_BOOT_METADATA assets for specified configuration were written successfully.

Also resets the boot attempts count for the given Configuration.

Returns ZX_ERR_INVALID_ARGS if Configuration.RECOVERY is passed in via configuration.

pub fn set_configuration_unbootable( &self, configuration: Configuration, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Updates persistent metadata identifying whether configuration is bootable. Should only be called in the following situations:

• Before KERNEL as well as optional VERIFIED_BOOT_METADATA assets for specified configuration are written.
• After successfully booting from a new configuration and marking it healthy. This method would be then called on the old configuration.
• After “successfully” booting from a new configuration, but encountering an unrecoverable error during health check. This method would be then called on the new configuration.

If the configuration is unbootable, no action is taken.

Returns ZX_ERR_INVALID_ARGS if Configuration.RECOVERY is passed in via configuration.

pub fn set_configuration_healthy( &self, configuration: Configuration, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Updates persistent metadata to mark a [fuchsia.paver/Configuration] as successful.

This function is typically used by the OS update system after having confirmed that the configuration works as intended and the “rollback to previous slot” logic is not needed anymore.

Compatibility between the newly successful configuration and the other configuration is unknown. Even if the other configuration was successful at one point, it may no longer be. This function adds a success mark to the given configuration but also removes any success mark on the other.

If configuration is unbootable or is [fuchsia.paver/Configuration.RECOVERY], response will be ZX_ERR_INVALID_ARGS.

• request configuration the Configuration to mark as healthy. Must not be RECOVERY.

• response status a zx_status value indicating success or failure.

pub fn set_one_shot_recovery( &self, ) -> QueryResponseFut<BootManagerSetOneShotRecoveryResult, DefaultFuchsiaResourceDialect>

Force device to boot to recovery in the next reboot/power cycle. This will only be triggered once and will be reset after the reboot. State of A/B configuration slot will not be affected.

pub fn flush(&self) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Flush all previously buffered writes to persistent storage.

Trait Implementations

impl BootManagerProxyInterface for BootManagerProxy

type QueryCurrentConfigurationResponseFut = QueryResponseFut<Result<Configuration, i32>>

type QueryActiveConfigurationResponseFut = QueryResponseFut<Result<Configuration, i32>>

type QueryConfigurationLastSetActiveResponseFut = QueryResponseFut<Result<Configuration, i32>>

type QueryConfigurationStatusResponseFut = QueryResponseFut<Result<ConfigurationStatus, i32>>

type QueryConfigurationStatusAndBootAttemptsResponseFut = QueryResponseFut<Result<BootManagerQueryConfigurationStatusAndBootAttemptsResponse, i32>>

type SetConfigurationActiveResponseFut = QueryResponseFut<i32>

type SetConfigurationUnbootableResponseFut = QueryResponseFut<i32>

type SetConfigurationHealthyResponseFut = QueryResponseFut<i32>

type SetOneShotRecoveryResponseFut = QueryResponseFut<Result<(), i32>>

type FlushResponseFut = QueryResponseFut<i32>

fn query_current_configuration( &self, ) -> Self::QueryCurrentConfigurationResponseFut

fn query_active_configuration( &self, ) -> Self::QueryActiveConfigurationResponseFut

fn query_configuration_last_set_active( &self, ) -> Self::QueryConfigurationLastSetActiveResponseFut

fn query_configuration_status( &self, configuration: Configuration, ) -> Self::QueryConfigurationStatusResponseFut

fn query_configuration_status_and_boot_attempts( &self, configuration: Configuration, ) -> Self::QueryConfigurationStatusAndBootAttemptsResponseFut

fn set_configuration_active( &self, configuration: Configuration, ) -> Self::SetConfigurationActiveResponseFut

fn set_configuration_unbootable( &self, configuration: Configuration, ) -> Self::SetConfigurationUnbootableResponseFut

fn set_configuration_healthy( &self, configuration: Configuration, ) -> Self::SetConfigurationHealthyResponseFut

fn set_one_shot_recovery(&self) -> Self::SetOneShotRecoveryResponseFut

fn flush(&self) -> Self::FlushResponseFut

impl Clone for BootManagerProxy

fn clone(&self) -> BootManagerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BootManagerProxy

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

Formats the value using the given formatter.

impl Proxy for BootManagerProxy

type Protocol = BootManagerMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.