[PATCH 1/2] rust: pci: document Bar's endianness conversion

From: Marko Turk
Date: Wed Dec 10 2025 - 06:27:57 EST


Document that the Bar's MMIO backend always assumes little-endian
devices and that its operations automatically convert to CPU endianness.

Signed-off-by: Marko Turk <mt@xxxxxxxxxxxxxx>
Link: https://lore.kernel.org/lkml/DE7F6RR1NAKW.3DJYO44O73941@xxxxxxxxxx/
---
rust/kernel/pci/io.rs | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/rust/kernel/pci/io.rs b/rust/kernel/pci/io.rs
index 0d55c3139b6f..bfa9df9e9bb9 100644
--- a/rust/kernel/pci/io.rs
+++ b/rust/kernel/pci/io.rs
@@ -18,9 +18,12 @@

/// A PCI BAR to perform I/O-Operations on.
///
+/// I/O backend assumes that the device is little-endian and will automatically
+/// convert from little-endian to CPU endianness.
+///
/// # Invariants
///
-/// `Bar` always holds an `IoRaw` inststance that holds a valid pointer to the start of the I/O
+/// `Bar` always holds an `IoRaw` instance that holds a valid pointer to the start of the I/O
/// memory mapped PCI BAR and its size.
pub struct Bar<const SIZE: usize = 0> {
pdev: ARef<Device>,
--
2.51.0