Struct ConfigSpace 

pub struct ConfigSpace<'a, T: ?Sized = Extended> { /* private fields */ }

A view of PCI configuration space of a device.

Provides typed read and write accessors for configuration registers using the standard pci_read_config_* and pci_write_config_* helpers.

The generic parameter T is the type of the view. The full configuration space is also a special type of view; in such cases, T can be Normal for 256-byte legacy configuration space or Extended for 4096-byte PCIe extended configuration space (default).

Invariants

ptr is aligned and range ptr..ptr + KnownSize::size(ptr) is within 0..pdev.cfg_size().into_raw().

Implementations

impl<'a> ConfigSpace<'a, Extended>

pub fn find_ext_capability<C: ExtCapability>( &self, ) -> Result<Option<ConfigSpace<'a, C>>>

Finds and projects an extended capability into its typed register layout.

Returns None if the device does not implement the capability.

Returns an error if the capability is present but its register span is too small or insufficiently aligned for C.

Examples

use kernel::{
    device::Bound,
    pci,
    prelude::*,
};

fn probe_sriov(pdev: &pci::Device<Bound>) -> Result {
    let Some(sriov) = pdev
        .config_space_extended()?
        .find_ext_capability::<pci::ExtSriovRegs>()?
    else {
        return Ok(());
    };

    let first_vf_offset = sriov.first_vf_offset();
    let mut vf_bars = sriov.vf_bars()?;
    let bar0 = vf_bars.next().ok_or(EINVAL)?;
    let bar1 = vf_bars.next().ok_or(EINVAL)?;
    let bar2 = vf_bars.next().ok_or(EINVAL)?;

    Ok(())
}

impl ConfigSpace<'_, ExtSriovRegs>

pub fn first_vf_offset(&self) -> u16

Returns the current PCIe First VF Offset in Routing ID space.

This value may change when NumVFs changes. Drivers should use PCI core helpers when they need to calculate a VF BDF; this accessor is intended for interfaces that require the First VF Offset itself.

pub fn vf_bars(&self) -> Result<impl Iterator<Item = ExtSriovVfBar>>

Returns an iterator over decoded VF BAR register encodings.

All six raw VF BAR register slots are read and decoded up front. A 32-bit encoding yields one entry; a 64-bit encoding combines two slots into one entry.

A zero-valued low DWORD is yielded as a 32-bit BAR at address zero; this method does not probe whether a BAR is implemented.

Returns EINVAL and logs an error if a BAR low DWORD does not encode a 32-bit or 64-bit memory BAR, or if a 64-bit encoding has no upper DWORD.

Trait Implementations

impl<T: ?Sized> Clone for ConfigSpace<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Copy for ConfigSpace<'_, T>

impl<'a, T: ?Sized + KnownSize> IoBase<'a> for ConfigSpace<'a, T>

type Backend = ConfigSpaceBackend

Type that defines all I/O operations.

type Target = T

Type of this I/O region. For untyped regions, Region can be used.

fn as_view(self) -> ConfigSpace<'a, T>

Return a view that covers the full region.

impl<T: ?Sized + Sync> Send for ConfigSpace<'_, T>

impl<T: ?Sized + Sync> Sync for ConfigSpace<'_, T>