Struct Object 

pub struct Object<T: DriverObject> { /* private fields */ }

A shmem-backed GEM object.

Invariants

• obj contains a valid initialized struct drm_gem_shmem_object for the lifetime of this object.

Implementations

impl<T: DriverObject> Object<T>

pub fn project<'__this>( self: Pin<&'__this mut Self>, ) -> __Projection<'__this, T>

Pin-projects all fields of Self.

These fields are structurally pinned:

• obj
• sgt_lock
• inner

These fields are not structurally pinned:

• parent_resv_obj
• sgt_res

pub fn with_project<'__this, R>( self: Pin<&'__this mut Self>, f: impl FnOnce(__ProjectionLt<'__this, T>) -> R, ) -> R

Pin-projects all fields of Self with proper lifetime.

These fields are structurally pinned:

• obj
• sgt_lock
• inner

These fields are not structurally pinned:

• parent_resv_obj
• sgt_res

pub fn with_project_ref<'__this, R>( self: Pin<&'__this Self>, f: impl FnOnce(__ProjectionRef<'__this, T>) -> R, ) -> R

Pin-projects all fields of Self from a shared reference with proper lifetime.

These fields are structurally pinned:

• obj
• sgt_lock
• inner

These fields are not structurally pinned:

• parent_resv_obj
• sgt_res

impl<T: DriverObject> Object<T>

pub fn dev(&self) -> &Device<T::Driver>

Returns the Device that owns this GEM object.

pub fn vmap<const SIZE: usize>(&self) -> Result<VMapRef<'_, T, SIZE>>

Creates and returns a virtual kernel memory mapping for this object.

pub fn sg_table<'a>(&'a self, dev: &'a Device<Bound>) -> Result<&'a SGTable>

Creates (if necessary) and returns an immutable reference to a scatter-gather table of DMA pages for this object.

This will pin the object in memory. It is expected that dev should be a pointer to the same device::Device which self belongs to, otherwise this function will return Err(EINVAL).

pub fn new( dev: &Device<T::Driver>, size: usize, config: ObjectConfig<'_, T>, args: T::Args, ) -> Result<ARef<Self>>

Create a new shmem-backed DRM object of the given size.

Additional config options can be specified using config.

pub fn owned_vmap<const SIZE: usize>(&self) -> Result<VMapOwned<T, SIZE>>

Creates and returns an owned reference to a virtual kernel memory mapping for this object.

Trait Implementations

impl<T: DriverObject> AllocImpl for Object<T>

const ALLOC_OPS: AllocOps

The C callback operations for this memory manager.

type Driver = <T as DriverObject>::Driver

The Driver implementation for this AllocImpl.

impl<T> AlwaysRefCounted for Object<T>

where Self: IntoGEMObject, T: DriverObject,

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.

impl<T: DriverObject> Deref for Object<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: DriverObject> DerefMut for Object<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: DriverObject> HasPinData for Object<T>

type PinData = __ThePinData<T>

fn __pin_data(_: InitData<Self>) -> Self::PinData

impl<T: DriverObject> IntoGEMObject for Object<T>

fn as_raw(&self) -> *mut drm_gem_object

Returns a reference to the raw drm_gem_object structure, which must be valid as long as this owning object is valid.

unsafe fn from_raw<'a>(obj: *mut drm_gem_object) -> &'a Self

Converts a pointer to a struct drm_gem_object into a reference to Self.

impl<T: DriverObject> Send for Object<T>

impl<T: DriverObject> Sync for Object<T>