rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: John Hubbard <jhubbard@nvidia.com>
To: Danilo Krummrich <dakr@kernel.org>,
	Alexandre Courbot <acourbot@nvidia.com>
Cc: "Joel Fernandes" <joelagnelf@nvidia.com>,
	"Timur Tabi" <ttabi@nvidia.com>,
	"Alistair Popple" <apopple@nvidia.com>,
	"David Airlie" <airlied@gmail.com>,
	"Simona Vetter" <simona@ffwll.ch>,
	"Bjorn Helgaas" <bhelgaas@google.com>,
	"Krzysztof Wilczyński" <kwilczynski@kernel.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	nouveau@lists.freedesktop.org, linux-pci@vger.kernel.org,
	rust-for-linux@vger.kernel.org,
	LKML <linux-kernel@vger.kernel.org>,
	"Elle Rhumsaa" <elle@weathered-steel.dev>
Subject: Re: [PATCH v6 2/5] rust: pci: provide access to PCI Vendor values
Date: Tue, 26 Aug 2025 13:38:18 -0700	[thread overview]
Message-ID: <b1cbdc99-317e-454c-bf03-d6793be5b13c@nvidia.com> (raw)
In-Reply-To: <DCBIPY9UJTT4.ETBXLTRGJWHO@kernel.org>

On 8/25/25 5:47 AM, Danilo Krummrich wrote:
> On Mon Aug 25, 2025 at 2:33 PM CEST, Alexandre Courbot wrote:
...
>> Naive question from someone with a device tree background and almost no
>> PCI experience: one consequence of using `From` here is that if I create
>> an non-registered Vendor value (e.g. `let vendor =
>> Vendor::from(0xf0f0)`), then do `vendor.as_raw()`, I won't get the value
>> passed initially but the one for `UNKNOWN`, e.g. `0xffff`. Are we ok
>> with this?
> 
> I think that's fine, since we shouldn't actually hit this. Drivers should only
> ever use the pre-defined constants of Vendor; consequently the
> Device::vendor_id() can't return UNKNOWN either.
> 
> So, I think the From impl is not ideal, since we can't limit its visibility. In
> order to improve this, I suggest to use Vendor::new() directly in the macro, and
> make Vendor::new() private. The same goes for Class, I guess.

Correction: when I went to implement this, I discovered that there is a better
way, which addresses both Alex's and your concerns. 

The incremental diff below shows how. It provides:

a) .from_raw(), which in this case matches conventions slightly better
   than new(). (I'm still learning that the Rust way is a bit different
   that the C++ way! haha).

b) Only the parent module (in this case, that's pci:: ) can call
   Class::from_raw(). This is exactly what we need. Fully private methods
   wouldn't work, but leaving it open for any caller to construct a
   Class item is also a problem.

c) Restored infallible operations, and with it, Alex's request for a
   reasonable behavior here now works once again:

       from_raw(0x10de).as_raw() == 0x10de
       

diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs
index 0faec49bf8a2..40047a7433b1 100644
--- a/rust/kernel/pci.rs
+++ b/rust/kernel/pci.rs
@@ -418,7 +418,7 @@ pub fn resource_len(&self, bar: u32) -> Result<bindings::resource_size_t> {
     /// Returns the PCI class as a `Class` struct.
     pub fn pci_class(&self) -> Class {
         // SAFETY: `self.as_raw` is a valid pointer to a `struct pci_dev`.
-        Class::new(unsafe { (*self.as_raw()).class })
+        Class::from_raw(unsafe { (*self.as_raw()).class })
     }
 }
 
diff --git a/rust/kernel/pci/id.rs b/rust/kernel/pci/id.rs
index 1291553b4e15..399436ffaab9 100644
--- a/rust/kernel/pci/id.rs
+++ b/rust/kernel/pci/id.rs
@@ -51,24 +51,15 @@ impl Class {
                 pub const $variant: Self = Self(Self::to_24bit_class($binding));
             )+
         }
-
-        /// Convert a raw 24-bit class code value to a `Class`.
-        impl From<u32> for Class {
-            fn from(value: u32) -> Self {
-                match value {
-                    $(x if x == Self::$variant.0 => Self::$variant,)+
-                    _ => Self::UNKNOWN,
-                }
-            }
-        }
     };
 }
 
 /// Once constructed, a `Class` contains a valid PCI Class code.
 impl Class {
-    /// Create a new Class from a raw 24-bit class code.
-    pub fn new(class_code: u32) -> Self {
-        Self::from(class_code)
+    /// Create a Class from a raw 24-bit class code.
+    /// Only accessible from the parent pci module.
+    pub(super) fn from_raw(class_code: u32) -> Self {
+        Self(class_code)
     }
 
     /// Get the raw 24-bit class code value.
@@ -235,5 +226,4 @@ fn try_from(value: u32) -> Result<Self, Self::Error> {
     ACCELERATOR_PROCESSING     = bindings::PCI_CLASS_ACCELERATOR_PROCESSING,     // 0x120000
 
     OTHERS                     = bindings::PCI_CLASS_OTHERS,                     // 0xff0000
-    UNKNOWN                    = 0xffffff,
 }


thanks,
-- 
John Hubbard


  parent reply	other threads:[~2025-08-26 20:38 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-22  2:03 [PATCH v6 0/5] rust, nova-core: PCI Class, Vendor support John Hubbard
2025-08-22  2:03 ` [PATCH v6 1/5] rust: pci: provide access to PCI Class and Class-related items John Hubbard
2025-08-25 12:17   ` Alexandre Courbot
2025-08-26  2:22     ` John Hubbard
2025-08-22  2:03 ` [PATCH v6 2/5] rust: pci: provide access to PCI Vendor values John Hubbard
2025-08-25 12:33   ` Alexandre Courbot
2025-08-25 12:47     ` Danilo Krummrich
2025-08-26  2:20       ` John Hubbard
2025-08-26 20:38       ` John Hubbard [this message]
2025-08-26 20:45         ` Danilo Krummrich
2025-08-26 20:58           ` John Hubbard
2025-08-26 21:00             ` Danilo Krummrich
2025-08-26 21:12               ` John Hubbard
2025-08-26  2:19     ` John Hubbard
2025-08-22  2:03 ` [PATCH v6 3/5] rust: pci: add DeviceId::from_class_and_vendor() method John Hubbard
2025-08-22  2:03 ` [PATCH v6 4/5] gpu: nova-core: avoid probing non-display/compute PCI functions John Hubbard
2025-08-22  2:03 ` [PATCH v6 5/5] rust: pci: use pci::Vendor instead of bindings::PCI_VENDOR_ID_* John Hubbard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b1cbdc99-317e-454c-bf03-d6793be5b13c@nvidia.com \
    --to=jhubbard@nvidia.com \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=airlied@gmail.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=apopple@nvidia.com \
    --cc=bhelgaas@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --cc=elle@weathered-steel.dev \
    --cc=gary@garyguo.net \
    --cc=joelagnelf@nvidia.com \
    --cc=kwilczynski@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=nouveau@lists.freedesktop.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=simona@ffwll.ch \
    --cc=tmgross@umich.edu \
    --cc=ttabi@nvidia.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).