Struct DeviceStatus 

#[repr(transparent)]
pub struct DeviceStatus(pub u8);

Modified by both the driver and the device during lifecycle transitions.

The bits are intended to represent stages in the device + driver lifecycle. After a device is reset, the value is guaranteed to be DeviceStatus::RESET.

With the exception of resetting the device, the driver must not clear (write 0 to) a bit that is set (to 1).

Tuple Fields

0: u8

Implementations

impl DeviceStatus

pub fn virtio_device_detected(&self) -> bool

True iff the driver recognized the hardware as a virtio device.

Set to true (1) by the driver in step 2 of device initialization.

The specification recommends that the virtualized operating system sets this bit. Fuchsia does not special-case virtio devices, so this bit is set by Fuchsia drivers.

pub fn driver_found(&self) -> bool

True iff the guest OS has found a driver for the device.

Set to true (1) by the driver in step 3 of device initialization. Fuchsia does not special-case virtio devices, so the driver must perform this step.

The driver may only read the feature bits offered by the device after setting this bit to true.

pub fn driver_initialized(&self) -> bool

True iff the driver is sufficiently initialized to drive the device.

Set to true (1) by the driver in step 8 of device initialization.

The driver must only set this bit to true after it has completed the device-specific initialization process.

The driver may only operate the device’s virtqueues while this bit is set to true (1).

pub fn feature_negotiation_complete(&self) -> bool

True iff the feature negotiation is complete.

Set to true (1) by the driver in step 5 of device initialization.

The driver must only set this bit to true after it has acknowledged all the features it understands.

pub fn suspended(&self) -> bool

True iff the device has been suspended by the driver.

The driver triggers device suspension by setting this bit to true (1). The device sets the [driver_initialized] bit to false (0) after the device completes suspending.

The driver triggers resuming a suspended device by setting the [driver_initialized] bit to true (1). The device sets this bit to false (0) after the device completes resuming.

The driver is only allowed to set this bit if [VirtioFeatureBits::suspend_enabled] is negotiated.

pub fn device_needs_reset(&self) -> bool

True iff the device has experienced an unrecoverable error.

The device sends a configuration change notification when setting this bit to true (1). The driver cannot assume that virtqueue operations will complete (or, conversely, that the operations will be dropped) while this bit is set.

pub fn driver_terminated(&self) -> bool

True iff the driver has experienced an unrecoverable error.

The driver sets this bit when it gives up on driving the device.

pub fn set_virtio_device_detected(&mut self, value: bool)

True iff the driver recognized the hardware as a virtio device.

Set to true (1) by the driver in step 2 of device initialization.

The specification recommends that the virtualized operating system sets this bit. Fuchsia does not special-case virtio devices, so this bit is set by Fuchsia drivers.

pub fn set_driver_found(&mut self, value: bool)

True iff the guest OS has found a driver for the device.

Set to true (1) by the driver in step 3 of device initialization. Fuchsia does not special-case virtio devices, so the driver must perform this step.

The driver may only read the feature bits offered by the device after setting this bit to true.

pub fn set_driver_initialized(&mut self, value: bool)

True iff the driver is sufficiently initialized to drive the device.

Set to true (1) by the driver in step 8 of device initialization.

The driver must only set this bit to true after it has completed the device-specific initialization process.

The driver may only operate the device’s virtqueues while this bit is set to true (1).

pub fn set_feature_negotiation_complete(&mut self, value: bool)

True iff the feature negotiation is complete.

Set to true (1) by the driver in step 5 of device initialization.

The driver must only set this bit to true after it has acknowledged all the features it understands.

pub fn set_suspended(&mut self, value: bool)

True iff the device has been suspended by the driver.

The driver triggers device suspension by setting this bit to true (1). The device sets the [driver_initialized] bit to false (0) after the device completes suspending.

The driver triggers resuming a suspended device by setting the [driver_initialized] bit to true (1). The device sets this bit to false (0) after the device completes resuming.

The driver is only allowed to set this bit if [VirtioFeatureBits::suspend_enabled] is negotiated.

pub fn set_device_needs_reset(&mut self, value: bool)

True iff the device has experienced an unrecoverable error.

The device sends a configuration change notification when setting this bit to true (1). The driver cannot assume that virtqueue operations will complete (or, conversely, that the operations will be dropped) while this bit is set.

pub fn set_driver_terminated(&mut self, value: bool)

True iff the driver has experienced an unrecoverable error.

The driver sets this bit when it gives up on driving the device.

impl DeviceStatus

pub const RESET: DeviceStatus

The status value that indicates the device has been reset.

Trait Implementations

impl<T> BitRange<T> for DeviceStatus

where u8: BitRange<T>,

fn bit_range(&self, msb: usize, lsb: usize) -> T

Get a range of bits.

impl<T> BitRangeMut<T> for DeviceStatus

where u8: BitRangeMut<T>,

fn set_bit_range(&mut self, msb: usize, lsb: usize, value: T)

Set a range of bits.

impl Clone for DeviceStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DeviceStatus

impl Debug for DeviceStatus

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

Formats the value using the given formatter.

impl Default for DeviceStatus

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DeviceStatus

impl PartialEq for DeviceStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DeviceStatus