Struct Device

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§

impl Device

pub fn vendor_id(&self) -> u16

Returns the PCI vendor ID.

pub fn device_id(&self) -> u16

Returns the PCI device ID.

pub fn revision_id(&self) -> u8

Returns the PCI revision ID.

pub fn dev_id(&self) -> u16

Returns the PCI bus device/function.

pub fn subsystem_vendor_id(&self) -> u16

Returns the PCI subsystem vendor ID.

pub fn subsystem_device_id(&self) -> u16

Returns the PCI subsystem device ID.

pub fn resource_start(&self, bar: u32) -> Result<resource_size_t>

Returns the start of the given PCI bar resource.

pub fn resource_len(&self, bar: u32) -> Result<resource_size_t>

Returns the size of the given PCI bar resource.

impl Device<Bound>

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

Mapps 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.

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

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

pub fn irq_vector(&self, index: u32) -> Result<IrqRequest<'_>>

Returns an IrqRequest for the IRQ vector at the given index, if any.

pub fn request_irq<'a, T: Handler + 'static>( &'a self, index: u32, 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 IRQ vector at the given index.

pub fn request_threaded_irq<'a, T: ThreadedHandler + 'static>( &'a self, index: u32, 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 IRQ vector at the given index.

impl Device<Core>

pub fn enable_device_mem(&self) -> Result

Enable memory resources for this device.

pub fn set_master(&self)

Enable bus-mastering for this device.

Trait Implementations§

impl AlwaysRefCounted for Device

fn inc_ref(&self)

Increments the reference count on the object.

unsafe fn dec_ref(obj: NonNull<Self>)

Decrements the reference count on the object. Read more

impl<Ctx: DeviceContext> AsRef<Device<Ctx>> for Device<Ctx>

fn as_ref(&self) -> &Device<Ctx>

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for Device<Bound>

type Target = Device

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Device<Core>

type Target = Device<Bound>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Device<CoreInternal>

type Target = Device<Core>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Device for Device<Core>

unsafe fn dma_set_mask(&self, mask: DmaMask) -> Result

Set up the device’s DMA streaming addressing capabilities. Read more

unsafe fn dma_set_coherent_mask(&self, mask: DmaMask) -> Result

Set up the device’s DMA coherent addressing capabilities. Read more

unsafe fn dma_set_mask_and_coherent(&self, mask: DmaMask) -> Result

Set up the device’s DMA addressing capabilities. Read more

impl From<&Device<Bound>> for ARef<Device>

fn from(dev: &Device<Bound>) -> Self

Converts to this type from the input type.

impl From<&Device<Core>> for ARef<Device>

fn from(dev: &Device<Core>) -> Self

Converts to this type from the input type.

impl From<&Device<CoreInternal>> for ARef<Device>

fn from(dev: &Device<CoreInternal>) -> Self

Converts to this type from the input type.

impl<Ctx: DeviceContext> TryFrom<&Device<Ctx>> for &Device<Ctx>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(dev: &Device<Ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl Send for Device

impl Sync for Device

Auto Trait Implementations§

impl<Ctx = Normal> !Freeze for Device<Ctx>

impl<Ctx = Normal> !RefUnwindSafe for Device<Ctx>

impl<Ctx = Normal> !Send for Device<Ctx>

impl<Ctx = Normal> !Sync for Device<Ctx>

impl<Ctx = Normal> !Unpin for Device<Ctx>

impl<Ctx> UnwindSafe for Device<Ctx>
where Ctx: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Init<T> for T

unsafe fn __init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PinInit<T> for T

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.