From: Zhi Wang <zhiw@nvidia.com>
To: <rust-for-linux@vger.kernel.org>
Cc: <dakr@kernel.org>, <bhelgaas@google.com>,
<kwilczynski@kernel.org>, <ojeda@kernel.org>,
<alex.gaynor@gmail.com>, <boqun.feng@gmail.com>,
<gary@garyguo.net>, <bjorn3_gh@protonmail.com>,
<lossin@kernel.org>, <a.hindborg@kernel.org>,
<aliceryhl@google.com>, <tmgross@umich.edu>,
<linux-pci@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<cjia@nvidia.com>, <smitra@nvidia.com>, <ankita@nvidia.com>,
<aniketa@nvidia.com>, <kwankhede@nvidia.com>,
<targupta@nvidia.com>, <zhiw@nvidia.com>, <zhiwang@kernel.org>,
<acourbot@nvidia.com>, <joelagnelf@nvidia.com>,
<jhubbard@nvidia.com>, <markus.probst@posteo.de>
Subject: [PATCH v3 4/5] rust: pci: add config space read/write support
Date: Thu, 30 Oct 2025 15:48:41 +0000 [thread overview]
Message-ID: <20251030154842.450518-5-zhiw@nvidia.com> (raw)
In-Reply-To: <20251030154842.450518-1-zhiw@nvidia.com>
Introduce a `ConfigSpace` wrapper in Rust PCI abstraction to provide safe
accessors for PCI configuration space. The new type implements the
`Io` trait to share offset validation and bound-checking logic with
others.
Signed-off-by: Zhi Wang <zhiw@nvidia.com>
---
rust/kernel/pci.rs | 62 +++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 61 insertions(+), 1 deletion(-)
diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs
index 9ebba8e08d2e..80bf0d2420f3 100644
--- a/rust/kernel/pci.rs
+++ b/rust/kernel/pci.rs
@@ -10,7 +10,8 @@
devres::Devres,
driver,
error::{from_result, to_result, Result},
- io::{Mmio, MmioRaw},
+ io::{define_read, define_write},
+ io::{Io, Mmio, MmioRaw},
irq::{self, IrqRequest},
str::CStr,
sync::aref::ARef,
@@ -305,6 +306,60 @@ pub struct Device<Ctx: device::DeviceContext = device::Normal>(
PhantomData<Ctx>,
);
+/// Represents the PCI configuration space of a device.
+///
+/// Provides typed read and write accessors for configuration registers
+/// using the standard `pci_read_config_*` and `pci_write_config_*` helpers.
+///
+/// The generic const parameter `SIZE` can be used to indicate the
+/// maximum size of the configuration space (e.g. 256 bytes for legacy,
+/// 4096 bytes for extended config space). The actual size is obtained
+/// from the underlying `struct pci_dev` via [`Device::cfg_size`].
+pub struct ConfigSpace<'a, const SIZE: usize = { ConfigSpaceSize::Extended as usize }> {
+ pdev: &'a Device<device::Core>,
+}
+
+macro_rules! call_config_read {
+ (fallible, $c_fn:ident, $self:ident, $ty:ty, $addr:expr) => {{
+ let mut val: $ty = 0;
+ let ret = unsafe { bindings::$c_fn($self.pdev.as_raw(), $addr as i32, &mut val) };
+ (ret == 0)
+ .then_some(Ok(val))
+ .unwrap_or_else(|| Err(Error::from_errno(ret)))
+ }};
+}
+
+macro_rules! call_config_write {
+ (fallible, $c_fn:ident, $self:ident, $ty:ty, $addr:expr, $value:expr) => {{
+ let ret = unsafe { bindings::$c_fn($self.pdev.as_raw(), $addr as i32, $value) };
+ (ret == 0)
+ .then_some(Ok(()))
+ .unwrap_or_else(|| Err(Error::from_errno(ret)))
+ }};
+}
+
+impl<'a, const SIZE: usize> Io<SIZE> for ConfigSpace<'a, SIZE> {
+ /// Returns the base address of this mapping.
+ #[inline]
+ fn addr(&self) -> usize {
+ 0
+ }
+
+ /// Returns the maximum size of this mapping.
+ #[inline]
+ fn maxsize(&self) -> usize {
+ self.pdev.cfg_size().map_or(0, |v| v as usize)
+ }
+
+ define_read!(fallible, try_read8, call_config_read, pci_read_config_byte -> u8);
+ define_read!(fallible, try_read16, call_config_read, pci_read_config_word -> u16);
+ define_read!(fallible, try_read32, call_config_read, pci_read_config_dword -> u32);
+
+ define_write!(fallible, try_write8, call_config_write, pci_write_config_byte <- u8);
+ define_write!(fallible, try_write16, call_config_write, pci_write_config_word <- u16);
+ define_write!(fallible, try_write32, call_config_write, pci_write_config_dword <- u32);
+}
+
/// A PCI BAR to perform I/O-Operations on.
///
/// # Invariants
@@ -615,6 +670,11 @@ pub fn set_master(&self) {
// SAFETY: `self.as_raw` is guaranteed to be a pointer to a valid `struct pci_dev`.
unsafe { bindings::pci_set_master(self.as_raw()) };
}
+
+ /// Return an initialized config space object.
+ pub fn config_space<'a>(&'a self) -> Result<ConfigSpace<'a>> {
+ Ok(ConfigSpace { pdev: self })
+ }
}
// SAFETY: `Device` is a transparent wrapper of a type that doesn't depend on `Device`'s generic
--
2.47.3
next prev parent reply other threads:[~2025-10-30 15:49 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-30 15:48 [PATCH v3 0/5] rust: pci: add config space read/write support Zhi Wang
2025-10-30 15:48 ` [PATCH v3 1/5] rust: io: factor common I/O helpers into Io trait Zhi Wang
2025-10-31 9:07 ` Alice Ryhl
2025-10-31 12:48 ` Zhi Wang
2025-10-31 12:55 ` Danilo Krummrich
2025-10-30 15:48 ` [PATCH v3 2/5] rust: io: factor out MMIO read/write macros Zhi Wang
2025-10-30 15:48 ` [PATCH v3 3/5] rust: pci: add a helper to query configuration space size Zhi Wang
2025-10-30 16:51 ` Bjorn Helgaas
2025-10-31 12:16 ` Zhi Wang
2025-10-31 12:46 ` Danilo Krummrich
2025-10-30 15:48 ` Zhi Wang [this message]
2025-10-31 12:48 ` [PATCH v3 4/5] rust: pci: add config space read/write support Danilo Krummrich
2025-10-31 12:50 ` Zhi Wang
2025-10-30 15:48 ` [PATCH v3 5/5] sample: rust: pci: add tests for config space routines Zhi Wang
2025-10-31 12:50 ` Danilo Krummrich
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=20251030154842.450518-5-zhiw@nvidia.com \
--to=zhiw@nvidia.com \
--cc=a.hindborg@kernel.org \
--cc=acourbot@nvidia.com \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=aniketa@nvidia.com \
--cc=ankita@nvidia.com \
--cc=bhelgaas@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=cjia@nvidia.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=jhubbard@nvidia.com \
--cc=joelagnelf@nvidia.com \
--cc=kwankhede@nvidia.com \
--cc=kwilczynski@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=markus.probst@posteo.de \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=smitra@nvidia.com \
--cc=targupta@nvidia.com \
--cc=tmgross@umich.edu \
--cc=zhiwang@kernel.org \
/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).