Struct NvmeController

pub struct NvmeController { /* private fields */ }

An NVMe controller.

Implementations

impl NvmeController

pub fn new( driver_source: &VmTaskDriverSource, guest_memory: GuestMemory, register_msi: &mut dyn RegisterMsi, register_mmio: &mut dyn RegisterMmioIntercept, caps: NvmeControllerCaps, ) -> Self

Creates a new NVMe controller.

pub fn client(&self) -> NvmeControllerClient

Returns a client for manipulating the NVMe controller at runtime.

pub fn read_bar0(&mut self, addr: u16, data: &mut [u8]) -> IoResult

Reads from the virtual BAR 0.

pub fn write_bar0(&mut self, addr: u16, data: &[u8]) -> IoResult

Writes to the virtual BAR 0.

pub fn fatal_error(&mut self)

Sets the CFS bit in the controller status register (CSTS), indicating that the controller has experienced “undefined” behavior.

Trait Implementations

impl ChangeDeviceState for NvmeController

fn start(&mut self)

Starts a device, allowing it to interact with the guest asynchronously.

async fn stop(&mut self)

Stops a device’s asynchronous work.

async fn reset(&mut self)

Resets the device state to its initial state, for a fresh boot.

impl ChipsetDevice for NvmeController

fn supports_mmio(&mut self) -> Option<&mut dyn MmioIntercept>

Optionally returns a trait object to send MMIO port intercepts to.

fn supports_pci(&mut self) -> Option<&mut dyn PciConfigSpace>

Optionally returns a trait object to send PCI config space accesses to.

fn supports_pio(&mut self) -> Option<&mut (dyn PortIoIntercept + 'static)>

Optionally returns a trait object to send IO port intercepts to.

fn supports_poll_device(&mut self) -> Option<&mut dyn PollDevice>

Optionally returns a trait object to send poll requests to.

fn supports_line_interrupt_target( &mut self, ) -> Option<&mut dyn LineInterruptTarget>

Optionally returns a trait object to send interrupt line changes to.

fn supports_handle_eoi(&mut self) -> Option<&mut dyn HandleEoi>

Optionally returns a trait object to send EOI requests to.

fn supports_acknowledge_pic_interrupt( &mut self, ) -> Option<&mut dyn AcknowledgePicInterrupt>

Optionally returns a trait object with which to acknowledge PIC interrupts.

impl InspectMut for NvmeController

fn inspect_mut(&mut self, req: Request<'_>)

Inspects the object.

impl MmioIntercept for NvmeController

fn mmio_read(&mut self, addr: u64, data: &mut [u8]) -> IoResult

Dispatch an MMIO read to the device with the given address.

fn mmio_write(&mut self, addr: u64, data: &[u8]) -> IoResult

Dispatch an MMIO write to the device with the given address.

fn get_static_regions(&mut self) -> &[(&str, RangeInclusive<u64>)]

Report a set of static static mmio regions (region_name, gpa_range) that cannot be remapped at runtime and are always registered.

impl PciConfigSpace for NvmeController

fn pci_cfg_read(&mut self, offset: u16, value: &mut u32) -> IoResult

Dispatch a PCI config space read to the device with the given address.

fn pci_cfg_write(&mut self, offset: u16, value: u32) -> IoResult

Dispatch a PCI config space write to the device with the given address.

fn suggested_bdf(&mut self) -> Option<(u8, u8, u8)>

Check if the device has a suggested (bus, device, function) it expects to be located at.

impl SaveRestore for NvmeController

type SavedState = SavedStateNotSupported

The concrete saved state type.

fn save(&mut self) -> Result<Self::SavedState, SaveError>

Saves the object’s state.

fn restore(&mut self, state: Self::SavedState) -> Result<(), RestoreError>

Restores the object’s state.