Struct VirtioPciDeviceBuilder 

pub struct VirtioPciDeviceBuilder { /* private fields */ }

Builder pattern instantiation for VirtioPciDevice.

The builder implements virtio initialization. This is a multi-step process because it mixes logic specific to each virtio device type with logic applicable to all devices that use the PCI transport.

Implementations

impl VirtioPciDeviceBuilder

pub async fn new( pci: ClientEnd<Device>, ) -> Result<VirtioPciDeviceBuilder, Status>

Returns a builder ready for feature bits negotiation.

See [offered_features()] for the next initialization step.

pub fn offered_features(&self) -> VirtioFeatureBits

Returns the features offered by the device.

Use the result to compute device type-specific accepted features, and then call [accept_features()].

pub async fn accept_features( &mut self, accepted_features: VirtioFeatureBits, ) -> Result<(), Status>

Leaves the virtio device ready for device type-specific initialization.

accepted_features must be a subset of the bits returned by [offered_features()].

After this method succeeds, perform device-specific initialization and then call [build()].

The directions above entail that the method completes feature negotiation, performs transport-specific initialization, and automatically configures all discovered virtqueues.

On failure, sets DeviceStatus::driver_terminated to true, signaling that the driver will abandon this device.

pub fn bti(&self) -> &Bti

Returns a BTI that can pin VMOs in device-addressable memory.

Intended to be used during device type-specific initialization.

pub fn take_device_configuration(&mut self) -> Option<MmioRegion<VmoMemory>>

Returns the memory area that holds device-specific configuration.

The device must present at least one [PciCapabilityType::DEVICE_CONFIGURATION] capability for any device type that has a device type-specific configuration.

Returns None if the device does not expose any device-specific configuration, or if the method is called more than once.

pub fn build(self) -> Result<VirtioPciDevice, Status>

Consumes the builder and produces an initialized device.

Must be called after device-specific initialization is completed, which must follow a successful call to [accept_features()].

On failure, sets DeviceStatus::driver_terminated to true, signaling that the driver will abandon this device.