Struct Device

Source

pub struct Device<Ctx: DeviceContext = Normal>(/* private fields */);

Expand description

The PCI device representation.

This structure represents the Rust abstraction for a C struct pci_dev. The implementation abstracts the usage of an already existing C struct pci_dev within Rust code that we get passed from the C side.

§Invariants

A Device instance represents a valid struct pci_dev created by the C portion of the kernel.

Implementations§

Source §

impl Device<Bound>

Source

pub fn iomap_region_sized<'a, const SIZE: usize>( &'a self, bar: u32, name: &'a CStr, ) -> impl PinInit<Devres<Bar<SIZE>>, Error> + 'a

Maps an entire PCI BAR after performing a region-request on it. I/O operation bound checks can be performed on compile time for offsets (plus the requested type size) < SIZE.

Source

pub fn iomap_region<'a>( &'a self, bar: u32, name: &'a CStr, ) -> impl PinInit<Devres<Bar>, Error> + 'a

Maps an entire PCI BAR after performing a region-request on it.

Source §

impl Device<Bound>

Source

pub fn request_irq<'a, T: Handler + 'static>( &'a self, vector: IrqVector<'a>, flags: Flags, name: &'static CStr, handler: impl PinInit<T, Error> + 'a, ) -> Result<impl PinInit<Registration<T>, Error> + 'a>

Returns a kernel::irq::Registration for the given IRQ vector.

Source

pub fn request_threaded_irq<'a, T: ThreadedHandler + 'static>( &'a self, vector: IrqVector<'a>, flags: Flags, name: &'static CStr, handler: impl PinInit<T, Error> + 'a, ) -> Result<impl PinInit<ThreadedRegistration<T>, Error> + 'a>

Returns a kernel::irq::ThreadedRegistration for the given IRQ vector.

Source

pub fn alloc_irq_vectors( &self, min_vecs: u32, max_vecs: u32, irq_types: IrqTypes, ) -> Result<RangeInclusive<IrqVector<'_>>>

Allocate IRQ vectors for this PCI device with automatic cleanup.

Allocates between min_vecs and max_vecs interrupt vectors for the device. The allocation will use MSI-X, MSI, or INTx interrupts based on the irq_types parameter and hardware capabilities. When multiple types are specified, the kernel will try them in order of preference: MSI-X first, then MSI, then INTx interrupts.

The allocated vectors are automatically freed when the device is unbound, using the devres (device resource management) system.

§Arguments

min_vecs - Minimum number of vectors required.
max_vecs - Maximum number of vectors to allocate.
irq_types - Types of interrupts that can be used.

§Returns

Returns a range of IRQ vectors that were successfully allocated, or an error if the allocation fails or cannot meet the minimum requirement.

§Examples

// Allocate using any available interrupt type in the order mentioned above.
let vectors = dev.alloc_irq_vectors(1, 32, pci::IrqTypes::all())?;

// Allocate MSI or MSI-X only (no INTx interrupts).
let msi_only = pci::IrqTypes::default()
    .with(pci::IrqType::Msi)
    .with(pci::IrqType::MsiX);
let vectors = dev.alloc_irq_vectors(4, 16, msi_only)?;

Source §

impl Device

Source

pub fn vendor_id(&self) -> Vendor

Returns the PCI vendor ID as Vendor.

§Examples

fn log_device_info(pdev: &pci::Device<Core>) -> Result {
    // Get an instance of `Vendor`.
    let vendor = pdev.vendor_id();
    dev_info!(
        pdev.as_ref(),
        "Device: Vendor={}, Device=0x{:x}\n",
        vendor,
        pdev.device_id()
    );
    Ok(())
}

Source