Enum fidl_fuchsia_paver::DynamicDataSinkRequest

pub enum DynamicDataSinkRequest {
    ReadAsset {
        configuration: Configuration,
        asset: Asset,
        responder: DynamicDataSinkReadAssetResponder,
    },
    WriteAsset {
        configuration: Configuration,
        asset: Asset,
        payload: Buffer,
        responder: DynamicDataSinkWriteAssetResponder,
    },
    WriteFirmware {
        configuration: Configuration,
        type_: String,
        payload: Buffer,
        responder: DynamicDataSinkWriteFirmwareResponder,
    },
    ReadFirmware {
        configuration: Configuration,
        type_: String,
        responder: DynamicDataSinkReadFirmwareResponder,
    },
    WriteVolumes {
        payload: ClientEnd<PayloadStreamMarker>,
        responder: DynamicDataSinkWriteVolumesResponder,
    },
    WriteOpaqueVolume {
        payload: Buffer,
        responder: DynamicDataSinkWriteOpaqueVolumeResponder,
    },
    WipeVolume {
        responder: DynamicDataSinkWipeVolumeResponder,
    },
    Flush {
        responder: DynamicDataSinkFlushResponder,
    },
    InitializePartitionTables {
        responder: DynamicDataSinkInitializePartitionTablesResponder,
    },
    WipePartitionTables {
        responder: DynamicDataSinkWipePartitionTablesResponder,
    },
}

Specialized DataSink with dynamic partition tables.

Variants

ReadAsset

Fields

configuration: Configuration

asset: Asset

responder: DynamicDataSinkReadAssetResponder

Reads partition corresponding to configuration and asset into a vmo and returns it.

WriteAsset

Fields

configuration: Configuration

asset: Asset

payload: Buffer

responder: DynamicDataSinkWriteAssetResponder

Writes partition corresponding to configuration and asset with data from payload. payload may need to be resized to the partition size, so the provided vmo must have been created with ZX_VMO_RESIZABLE or must be a child VMO that was created with ZX_VMO_CHILD_RESIZABLE. Will zero out rest of the partition if payload is smaller than the size of the partition being written.

Returns ZX_ERR_INVALID_ARGS if configuration specifies active configuration.

WriteFirmware

Fields

configuration: Configuration

type_: String

payload: Buffer

responder: DynamicDataSinkWriteFirmwareResponder

Writes firmware data from payload.

configuration represents the A/B/R configuration. For platforms that do not support firmware A/B/R, the parameter will be ignored by the underlying device-specific logic .

type is a device-specific string identifying the payload contents, used to select the proper paving logic. For example, a device with multiple bootloader stages might send them as separate calls to WriteFirmware(), differentiated by type. An empty string indicates the default type.

payload may need to be resized to the partition size, so the provided vmo must have been created with ZX_VMO_RESIZABLE or must be a child VMO that was created with ZX_VMO_CHILD_RESIZABLE.

ReadFirmware

Fields

configuration: Configuration

type_: String

responder: DynamicDataSinkReadFirmwareResponder

Read firmware corresponding to configuration and type.

Parameter configuration and type are the same as WriteFirmware.

If ReadFirmware returns error, caller should assume that firmware image does not exist or is in a bad state, or firmware read is not defined for the product.

WriteVolumes

Fields

payload: ClientEnd<PayloadStreamMarker>

responder: DynamicDataSinkWriteVolumesResponder

Writes FVM with data from streamed via payload. This potentially affects all configurations.

WriteOpaqueVolume

Fields

payload: Buffer

responder: DynamicDataSinkWriteOpaqueVolumeResponder

Write a raw volume image to the device. The image will be passed as it is to the device partitioner backend to write. Therefore the format and write logic for the image is up to the product to define. It differs from WriteVolume(), which is specifically for writing the FVM sparse image, in that the paver will not perform any FVM related parsing or other operation of the image. Thus it is not dependent on the volume driver version and less susceptible to an outdated paver.

Returns ZX_ERR_NOT_SUPPORTED if the backend does not support opaque volume blobs.

WipeVolume

Fields

responder: DynamicDataSinkWipeVolumeResponder

Wipes the FVM partition from the device. Should not be confused with factory reset, which is less intrusive. The result is that the default FVM volumes are re-created, but empty.

Notable use cases include recovering from corrupted FVM as well as setting device to a “clean” state for automation.

If block_device is not provided, the paver will perform a search for the the FVM. If multiple block devices have valid GPT, block_device can be provided to specify which one to target. It assumed that channel backing block_device also implements fuchsia.io.Node for now.

On success, returns a channel to the initialized FVM volume.

Flush

Fields

responder: DynamicDataSinkFlushResponder

Flush all previously buffered writes to persistent storage.

InitializePartitionTables

Fields

responder: DynamicDataSinkInitializePartitionTablesResponder

Initializes partitions on given block device.

WipePartitionTables

Fields

responder: DynamicDataSinkWipePartitionTablesResponder

Wipes all entries from the partition table of the specified block device. Currently only supported on devices with a GPT.

WARNING: This API may destructively remove non-fuchsia maintained partitions from the block device.

Implementations

impl DynamicDataSinkRequest

pub fn into_read_asset( self ) -> Option<(Configuration, Asset, DynamicDataSinkReadAssetResponder)>

pub fn into_write_asset( self ) -> Option<(Configuration, Asset, Buffer, DynamicDataSinkWriteAssetResponder)>

pub fn into_write_firmware( self ) -> Option<(Configuration, String, Buffer, DynamicDataSinkWriteFirmwareResponder)>

pub fn into_read_firmware( self ) -> Option<(Configuration, String, DynamicDataSinkReadFirmwareResponder)>

pub fn into_write_volumes( self ) -> Option<(ClientEnd<PayloadStreamMarker>, DynamicDataSinkWriteVolumesResponder)>

pub fn into_write_opaque_volume( self ) -> Option<(Buffer, DynamicDataSinkWriteOpaqueVolumeResponder)>

pub fn into_wipe_volume(self) -> Option<DynamicDataSinkWipeVolumeResponder>

pub fn into_flush(self) -> Option<DynamicDataSinkFlushResponder>

pub fn into_initialize_partition_tables( self ) -> Option<DynamicDataSinkInitializePartitionTablesResponder>

pub fn into_wipe_partition_tables( self ) -> Option<DynamicDataSinkWipePartitionTablesResponder>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for DynamicDataSinkRequest

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

Formats the value using the given formatter.