From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EBCBA205AAC for ; Wed, 5 Mar 2025 23:06:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741215997; cv=none; b=quh8Tdvbb7SK9YsoweyPTBuFN5gdSQZ3hSy3as/W3c2F2qdbqG8YP0lQt3XGQs4LIrOqo4AN8sjK7jeHyD/z60u8a2XQpvvwex1dSetI0473Gt4Fm90O6jyj7WLp2vZhht65zGNWECo2lAJvc6YM80Go5E/P0veVq1jwQuPAcV0= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741215997; c=relaxed/simple; bh=2+RRzJxxj1ihztsyI9/kCaraPGgQqeBZMu73tpjGOpM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=HE4SDoOXg2hkyz6Sdjechsm54keLSv3eHqgpYUtqX2GNiBNYN7x2AQim7BCaqPBVgUIwXIxbSrR15+ZBn+rzo6cfqAPIchXrgUzFmpB1rKgYkf8asrOrH607kiud70Vi5r+ssfEE1Dcl0jzkJ4bIDdruQVB+ryx6NJvb1XMpfKI= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=DneKys5/; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="DneKys5/" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741215995; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=lI0pBqW1V5q10bkXXVuUMbPUNgGv55fdwvDT8YLI59Y=; b=DneKys5/IDgHcVgoYmsDw/TsPZu41odxBx1e1cNFidwKDMa+osiCRp5MJ53gQFMOrjcvT0 t6Tg+/xm8T1d5l6QzRV+S/Yu4MuFAgN+vaBItb8oJItZSZXSBnASGYnpiFGUchLJSquSWu 3Wgm3QA0BVJQtVBatwWYpJxzFn4oNL4= Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-456-CS-WicQbPn64VR2-SL284A-1; Wed, 05 Mar 2025 18:06:29 -0500 X-MC-Unique: CS-WicQbPn64VR2-SL284A-1 X-Mimecast-MFC-AGG-ID: CS-WicQbPn64VR2-SL284A_1741215987 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 61E7419560B4; Wed, 5 Mar 2025 23:06:27 +0000 (UTC) Received: from chopper.redhat.com (unknown [10.22.88.81]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A6C8430001A1; Wed, 5 Mar 2025 23:06:23 +0000 (UTC) From: Lyude Paul To: dri-devel@lists.freedesktop.org, rust-for-linux@vger.kernel.org Cc: Danilo Krummrich , mcanal@igalia.com, Alice Ryhl , Maxime Ripard , Simona Vetter , Daniel Almeida , Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Trevor Gross , linux-kernel@vger.kernel.org (open list) Subject: [RFC v3 13/33] rust: drm/kms: Add RawPlane and RawPlaneState Date: Wed, 5 Mar 2025 17:59:29 -0500 Message-ID: <20250305230406.567126-14-lyude@redhat.com> In-Reply-To: <20250305230406.567126-1-lyude@redhat.com> References: <20250305230406.567126-1-lyude@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 Same thing as RawCrtc and RawCrtcState, but for DRM planes now Signed-off-by: Lyude Paul --- V3: * Limit unsafe scope in RawPlane::index() * Improve safety comments Signed-off-by: Lyude Paul --- rust/kernel/drm/kms/plane.rs | 37 ++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/rust/kernel/drm/kms/plane.rs b/rust/kernel/drm/kms/plane.rs index 9f262156eac6c..d1fabdf42df54 100644 --- a/rust/kernel/drm/kms/plane.rs +++ b/rust/kernel/drm/kms/plane.rs @@ -373,6 +373,29 @@ pub unsafe trait ModesettablePlane: AsRawPlane { type State: FromRawPlaneState; } +/// 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 planes to users, and does not change + // throughout its lifetime + // - `.as_raw()` always returns a valid poiinter. + 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 RawPlane for T {} + /// A trait implemented by any type which can produce a reference to a [`struct drm_plane_state`]. /// /// This is implemented internally by DRM. @@ -436,6 +459,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 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.48.1