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
On Thu Oct 30, 2025 at 4:48 PM CET, Zhi Wang wrote:
> +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);
> +}
Please also implement the infallible ones.
> +
> /// 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 })
> + }
Please see [1].
[1] https://lore.kernel.org/lkml/DDWINZJUGVQ8.POKS7A6ZSRFK@kernel.org/
On Fri, 31 Oct 2025 13:48:41 +0100
"Danilo Krummrich" <dakr@kernel.org> wrote:
> On Thu Oct 30, 2025 at 4:48 PM CET, Zhi Wang wrote:
> > +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); +}
>
> Please also implement the infallible ones.
>
Thanks. Will do this in the next spin.
> > +
> > /// 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 })
> > + }
>
> Please see [1].
>
> [1] https://lore.kernel.org/lkml/DDWINZJUGVQ8.POKS7A6ZSRFK@kernel.org/
© 2016 - 2026 Red Hat, Inc.