Struct PciExpressCapability 

pub struct PciExpressCapability { /* private fields */ }

Configurable PCI Express capability.

Implementations

impl PciExpressCapability

pub fn new( typ: DevicePortType, flr_handler: Option<Arc<dyn FlrHandler>>, ) -> Self

Creates a new PCI Express capability with FLR support.

Arguments

• typ - The spec-defined device or port type.
• flr_handler - Optional handler to be called when FLR is initiated. This emulator will report that FLR is supported if flr_handler = Some(_)

pub fn with_hotplug_support(self, slot_number: u32) -> Self

Enable hotplug support for this PCIe capability. This configures the appropriate registers to support hotpluggable devices. Panics if called on device types other than RootPort or DownstreamSwitchPort.

Arguments

• slot_number - The physical slot number to assign to this hotplug-capable port

pub fn with_tlp_prefixing_supported( self, max_prefixes: MaxEndEndTlpPrefixes, ) -> Self

Enable TLP prefixing support for this PCIe capability.

This configures the appropriate registers to indicate that the function supports end-to-end TLP prefixes. We do not currently implement TLP prefixing in endpoint DMA APIs but this still may be required for ports upstream of passthrough devices that support TLP prefixing (ex. for guest controlled PASID with a virtual IOMMU).

pub fn set_presence_detect_state(&self, present: bool)

Set the physical presence state used to derive slot and link status.

Arguments

• present - true if a device is present in the slot, false if the slot is empty

pub fn set_hotplug_changed_bits(&self)

Set the RW1C changed bits in Slot Status to signal a hotplug event. Call this only for runtime hotplug events, not build-time device attachment.

pub fn set_hotplug_state(&self, present: bool)

Atomically update presence detect state, link active state, and changed bits for a hotplug event.

pub fn hot_plug_interrupt_enabled(&self) -> bool

Returns whether the hot plug interrupt is enabled in Slot Control.

pub fn ari_forwarding_enable(&self) -> bool

Returns whether ARI Forwarding is enabled in Device Control 2.

When set on a downstream-facing port, the port no longer enforces the requirement that the Device Number be 0 when turning a Type 1 configuration request into a Type 0 request, allowing the full 8-bit ARI function number to reach the connected device. See PCIe Base Spec 7.0 §6.13.

pub fn slot_capabilities(&self) -> &SlotCapabilities

Returns a reference to the slot capabilities register.

Trait Implementations

impl Inspect for PciExpressCapability

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

Inspects the object.

impl PciCapability for PciExpressCapability

fn label(&self) -> &str

A descriptive label for use in Save/Restore + Inspect output

fn capability_id(&self) -> CapabilityId

Returns the PCI capability ID for this capability

fn len(&self) -> usize

Length of the capability structure

fn read(&self, offset: u16, value: ByteEnabledDwordRead<'_>)

Read a byte-enabled DWORD at the given capability-relative offset. The offset must be 32-bit aligned.

fn write(&mut self, offset: u16, val: ByteEnabledDwordWrite)

Write a byte-enabled DWORD to the given capability-relative offset. The offset must be 32-bit aligned.

fn reset(&mut self)

Reset the capability

fn as_pci_express(&self) -> Option<&PciExpressCapability>

Downcast to PCI Express capability

fn as_pci_express_mut(&mut self) -> Option<&mut PciExpressCapability>

Downcast to PCI Express capability (mutable)

fn as_msi_cap(&self) -> Option<&MsiCapability>

Downcast to MSI capability

fn as_msi_cap_mut(&mut self) -> Option<&mut MsiCapability>

Downcast to MSI capability (mutable)

impl SaveRestore for PciExpressCapability

type SavedState = SavedState

The concrete saved state type.

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

Saves the object’s state.

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

Restores the object’s state.