fidl_fuchsia_paver

Enum DataSinkRequest

Source
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.

Fields

§configuration: Configuration
§asset: Asset
§

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.

Fields

§configuration: Configuration
§asset: Asset
§payload: Buffer
§

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.

Fields

§configuration: Configuration
§type_: String
§payload: Buffer
§

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.

Fields

§configuration: Configuration
§type_: String
§

WriteVolumes

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

Fields

§payload: ClientEnd<PayloadStreamMarker>
§

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

Implementations§

Trait Implementations§

Source§

impl Debug for DataSinkRequest

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more