Same thing as RawCrtc and RawCrtcState, but for DRM planes now
Signed-off-by: Lyude Paul <lyude@xxxxxxxxxx>
---
rust/kernel/drm/kms/plane.rs | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/rust/kernel/drm/kms/plane.rs b/rust/kernel/drm/kms/plane.rs
index 3ace487316d46..1c151ae3b3dcc 100644
--- a/rust/kernel/drm/kms/plane.rs
+++ b/rust/kernel/drm/kms/plane.rs
@@ -312,6 +312,27 @@ unsafe impl<T: DriverPlane> Send for Plane<T> {}
// SAFETY: Our interface is thread-safe.
unsafe impl<T: DriverPlane> Sync for Plane<T> {}
+/// Common methods available on any type which implements [`AsRawPlane`].
+///
+/// This is implemented internally by DRM, and provides many of the basic methods for working with
+/// planes.
+pub trait RawPlane: AsRawPlane {
+ /// Return the index of this DRM plane
+ #[inline]
+ fn index(&self) -> u32 {
+ // SAFETY: The index is initialized by the time we expose `Plane` objects to users, and is
+ // invariant throughout the lifetime of the `Plane`
+ unsafe { (*self.as_raw()).index }
+ }
+
+ /// Return the index of this DRM plane in the form of a bitmask
+ #[inline]
+ fn mask(&self) -> u32 {
+ 1 << self.index()
+ }
+}
+impl<T: AsRawPlane> RawPlane for T {}
+
/// A [`struct drm_plane`] without a known [`DriverPlane`] implementation.
///
/// This is mainly for situations where our bindings can't infer the [`DriverPlane`] implementation
@@ -426,6 +447,20 @@ pub trait FromRawPlaneState: AsRawPlaneState {
unsafe fn from_raw_mut<'a>(ptr: *mut bindings::drm_plane_state) -> &'a mut Self;
}
+/// Common methods available on any type which implements [`AsRawPlane`].
+///
+/// This is implemented internally by DRM, and provides many of the basic methods for working with
+/// the atomic state of [`Plane`]s.
+pub trait RawPlaneState: AsRawPlaneState {
+ /// Return the plane that this plane state belongs to.
+ fn plane(&self) -> &Self::Plane {
+ // SAFETY: The index is initialized by the time we expose Plane objects to users, and is
+ // invariant throughout the lifetime of the Plane
+ unsafe { Self::Plane::from_raw(self.as_raw().plane) }
+ }
+}
+impl<T: AsRawPlaneState + ?Sized> RawPlaneState for T {}
+
/// The main interface for a [`struct drm_plane_state`].
///
/// This type is the main interface for dealing with the atomic state of DRM planes. In addition, it
--
2.46.1
