Re: [PATCH v2 3/3] rust: pci: provide access to PCI Vendor values
From: Elle Rhumsaa <hidden>
Date: 2025-08-20 03:54:35
Also in:
linux-pci, lkml, nouveau
On Sun, Aug 17, 2025 at 06:33:05PM -0700, John Hubbard wrote:
quoted hunk ↗ jump to hunk
This allows callers to write Vendor::SOME_COMPANY instead of bindings::PCI_VENDOR_ID_SOME_COMPANY. It also allows removing "use kernel::bindings" entirely from most of the affected files here. Apply this to the various Rust for Linux callers who were previously using bindings::PCI_VENDOR_ID_*. New APIs: Vendor::SOME_COMPANY Vendor::from_u32(), as_u32() DeviceId::from_class_and_vendor() now takes Vendor type Cc: Danilo Krummrich <dakr@kernel.org> Signed-off-by: John Hubbard <jhubbard@nvidia.com> --- drivers/gpu/nova-core/driver.rs | 12 +- rust/kernel/pci.rs | 327 +++++++++++++++++++++++++- samples/rust/rust_dma.rs | 3 +- samples/rust/rust_driver_auxiliary.rs | 4 +- samples/rust/rust_driver_pci.rs | 4 +- 5 files changed, 338 insertions(+), 12 deletions(-)diff --git a/drivers/gpu/nova-core/driver.rs b/drivers/gpu/nova-core/driver.rs index 4ec5b861a345..d0272289f863 100644 --- a/drivers/gpu/nova-core/driver.rs +++ b/drivers/gpu/nova-core/driver.rs@@ -1,7 +1,13 @@ // SPDX-License-Identifier: GPL-2.0 use kernel::{ - auxiliary, bindings, c_str, device::Core, pci, pci::Class, prelude::*, sizes::SZ_16M, sync::Arc, + auxiliary, c_str, + device::Core, + pci, + pci::{Class, Vendor}, + prelude::*, + sizes::SZ_16M, + sync::Arc, }; use crate::gpu::Gpu;@@ -26,7 +32,7 @@ pub(crate) struct NovaCore { pci::DeviceId::from_class_and_vendor( Class::DISPLAY_VGA, Class::MASK_CLASS_SUBCLASS, - bindings::PCI_VENDOR_ID_NVIDIA + Vendor::NVIDIA ), () ),@@ -34,7 +40,7 @@ pub(crate) struct NovaCore { pci::DeviceId::from_class_and_vendor( Class::DISPLAY_3D, Class::MASK_CLASS_SUBCLASS, - bindings::PCI_VENDOR_ID_NVIDIA + Vendor::NVIDIA ), () ),diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs index 9caa1d342d52..7a42b91ad873 100644 --- a/rust/kernel/pci.rs +++ b/rust/kernel/pci.rs@@ -196,6 +196,327 @@ pub const fn as_u32(self) -> u32 { OTHERS = bindings::PCI_CLASS_OTHERS, // 0xff0000 } +macro_rules! define_all_pci_vendors { + ( + $($variant:ident = $binding:expr,)+ + ) => { + /// PCI vendor IDs. + /// + /// Each entry contains the 16-bit PCI vendor ID as assigned by the PCI SIG. + /// These IDs uniquely identify the manufacturer of a PCI device. + /// All values are derived from kernel constants. + #[derive(Debug, Clone, Copy, PartialEq, Eq)] + #[repr(transparent)] + pub struct Vendor(u32); + + impl Vendor { + // Associated constants derived from kernel bindings + $( + #[allow(missing_docs)] + pub const $variant: Self = Self($binding); + )+ + + /// Create a `Vendor` from the raw vendor ID value, or `None` if the value doesn't + /// match any known vendor. + pub fn from_u32(value: u32) -> Option<Self> { + match value { + $(x if x == Self::$variant.0 => Some(Self::$variant),)+ + _ => None, + } + } + + /// Get the raw 16-bit vendor ID value. + pub const fn as_u32(self) -> u32 { + self.0 + } + } + }; +} + +define_all_pci_vendors! { + PCI_SIG = bindings::PCI_VENDOR_ID_PCI_SIG, // 0x0001 + + ... + + NCUBE = bindings::PCI_VENDOR_ID_NCUBE, // 0x10ff +} + /// An adapter for the registration of PCI drivers. pub struct Adapter<T: Driver>(T);@@ -335,9 +656,9 @@ pub const fn from_class(class: u32, class_mask: u32) -> Self { /// /// This is more targeted than [`DeviceId::from_class`]: in addition to matching by Vendor, it /// also matches the PCI Class (up to the entire 24 bits, depending on the mask). - pub const fn from_class_and_vendor(class: Class, class_mask: u32, vendor: u32) -> Self { + pub const fn from_class_and_vendor(class: Class, class_mask: u32, vendor: Vendor) -> Self { Self(bindings::pci_device_id { - vendor, + vendor: vendor.as_u32(), device: DeviceId::PCI_ANY_ID, subvendor: DeviceId::PCI_ANY_ID, subdevice: DeviceId::PCI_ANY_ID,@@ -396,7 +717,7 @@ macro_rules! pci_device_table { /// <MyDriver as pci::Driver>::IdInfo, /// [ /// ( -/// pci::DeviceId::from_id(bindings::PCI_VENDOR_ID_REDHAT, bindings::PCI_ANY_ID as u32), +/// pci::DeviceId::from_id(pci::Vendor::REDHAT.as_u32(), bindings::PCI_ANY_ID as u32), /// (), /// ) /// ]diff --git a/samples/rust/rust_dma.rs b/samples/rust/rust_dma.rs index c5e7cce68654..520c59b930dc 100644 --- a/samples/rust/rust_dma.rs +++ b/samples/rust/rust_dma.rs@@ -5,7 +5,6 @@ //! To make this driver probe, QEMU must be run with `-device pci-testdev`. use kernel::{ - bindings, device::Core, dma::{CoherentAllocation, Device, DmaMask}, pci,@@ -46,7 +45,7 @@ unsafe impl kernel::transmute::FromBytes for MyStruct {} MODULE_PCI_TABLE, <DmaSampleDriver as pci::Driver>::IdInfo, [( - pci::DeviceId::from_id(bindings::PCI_VENDOR_ID_REDHAT, 0x5), + pci::DeviceId::from_id(pci::Vendor::REDHAT.as_u32(), 0x5), () )] );diff --git a/samples/rust/rust_driver_auxiliary.rs b/samples/rust/rust_driver_auxiliary.rs index f2a820683fc3..d8470e4bf88b 100644 --- a/samples/rust/rust_driver_auxiliary.rs +++ b/samples/rust/rust_driver_auxiliary.rs@@ -5,7 +5,7 @@ //! To make this driver probe, QEMU must be run with `-device pci-testdev`. use kernel::{ - auxiliary, bindings, c_str, device::Core, driver, error::Error, pci, prelude::*, InPlaceModule, + auxiliary, c_str, device::Core, driver, error::Error, pci, prelude::*, InPlaceModule, }; use pin_init::PinInit;@@ -51,7 +51,7 @@ struct ParentDriver { MODULE_PCI_TABLE, <ParentDriver as pci::Driver>::IdInfo, [( - pci::DeviceId::from_id(bindings::PCI_VENDOR_ID_REDHAT, 0x5), + pci::DeviceId::from_id(pci::Vendor::REDHAT.as_u32(), 0x5), () )] );diff --git a/samples/rust/rust_driver_pci.rs b/samples/rust/rust_driver_pci.rs index 606946ff4d7f..a3a7a0837961 100644 --- a/samples/rust/rust_driver_pci.rs +++ b/samples/rust/rust_driver_pci.rs@@ -4,7 +4,7 @@ //! //! To make this driver probe, QEMU must be run with `-device pci-testdev`. -use kernel::{bindings, c_str, device::Core, devres::Devres, pci, prelude::*, types::ARef}; +use kernel::{c_str, device::Core, devres::Devres, pci, prelude::*, types::ARef}; struct Regs;@@ -38,7 +38,7 @@ struct SampleDriver { MODULE_PCI_TABLE, <SampleDriver as pci::Driver>::IdInfo, [( - pci::DeviceId::from_id(bindings::PCI_VENDOR_ID_REDHAT, 0x5), + pci::DeviceId::from_id(pci::Vendor::REDHAT.as_u32(), 0x5), TestIndex::NO_EVENTFD )] );-- 2.50.1
Reviewed-by: Elle Rhumsaa <redacted>