pub enum DataSinkRequest {
ReadAsset {
configuration: Configuration,
asset: Asset,
responder: DataSinkReadAssetResponder,
},
WriteAsset {
configuration: Configuration,
asset: Asset,
payload: Buffer,
responder: DataSinkWriteAssetResponder,
},
WriteFirmware {
configuration: Configuration,
type_: String,
payload: Buffer,
responder: DataSinkWriteFirmwareResponder,
},
ReadFirmware {
configuration: Configuration,
type_: String,
responder: DataSinkReadFirmwareResponder,
},
WriteVolumes {
payload: ClientEnd<PayloadStreamMarker>,
responder: DataSinkWriteVolumesResponder,
},
WriteOpaqueVolume {
payload: Buffer,
responder: DataSinkWriteOpaqueVolumeResponder,
},
WriteSparseVolume {
payload: Buffer,
responder: DataSinkWriteSparseVolumeResponder,
},
Flush {
responder: DataSinkFlushResponder,
},
}
Expand description
Protocol for reading and writing boot partitions.
A note on DataSink.Flush() (and BootManager.Flush() coming after):
Some platforms may implement the Flush() fidl interface of DataSink/BootManager. For these platforms, the update of some system images and A/B configuration is not persisted to storage immediately and only buffered internally when the write fidl interfaces return. The data is guaranteed to be persisted only after the Flush() interfaces are called.
If not implemented, Flush() is no-op and system images and A/B configuration will be persisted to storage immediately after the write fidl interfaces return.
For all platforms, it is guaranteed that if DataSink.Flush() is implemented, BootManager.Flush() is implemented as well. Therefore, in the context of system update, both of the following update sequences are safe in the sense that, new A/B configuration will not be persisted to storage before new system images. DataSink.Write… –> DataSink.Flush() –> BootManager.Set… –> BootManager.Flush() DataSink.Write… –> BootManager.Set… –> DataSink.Flush() –> BootManager.Flush()
Variants§
ReadAsset
Reads the partition corresponding to configuration
and asset
into a vmo and returns it.
The size field of the returned Buffer
will be the size of just the asset, if it can be
determined. Otherwise, it will be the size of the entire partition.
The size and stream size of the vmo in the returned Buffer
will always be the size of the
entire partition.
WriteAsset
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
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
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
Writes FVM with data from streamed via payload
. This potentially affects all
configurations.
WriteOpaqueVolume
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.
WriteSparseVolume
Writes an image in the Android Sparse format. Identical in behaviour to
WriteOpaqueVolume
, except the contents of payload
are parsed as a sparse image and
unpacked before being written to disk.
Flush
Flush all previously buffered writes to persistent storage.
Fields
responder: DataSinkFlushResponder
Implementations§
Source§impl DataSinkRequest
impl DataSinkRequest
pub fn into_read_asset( self, ) -> Option<(Configuration, Asset, DataSinkReadAssetResponder)>
pub fn into_write_asset( self, ) -> Option<(Configuration, Asset, Buffer, DataSinkWriteAssetResponder)>
pub fn into_write_firmware( self, ) -> Option<(Configuration, String, Buffer, DataSinkWriteFirmwareResponder)>
pub fn into_read_firmware( self, ) -> Option<(Configuration, String, DataSinkReadFirmwareResponder)>
pub fn into_write_volumes( self, ) -> Option<(ClientEnd<PayloadStreamMarker>, DataSinkWriteVolumesResponder)>
pub fn into_write_opaque_volume( self, ) -> Option<(Buffer, DataSinkWriteOpaqueVolumeResponder)>
pub fn into_write_sparse_volume( self, ) -> Option<(Buffer, DataSinkWriteSparseVolumeResponder)>
pub fn into_flush(self) -> Option<DataSinkFlushResponder>
Sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Name of the method defined in FIDL