From: Rahul Rameshbabu <sergeantsagara@protonmail.com>
Date: Sun, 6 Jul 2025 04:00:32 +0000 (+0000)
Subject: rust: pci: fix documentation related to Device instances
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5cddd546df0fa21316735d1d60fe826886e0dc21;p=thirdparty%2Flinux.git

rust: pci: fix documentation related to Device instances

Device instances in the pci crate represent a valid struct pci_dev, not a
struct device.

Fixes: 7b948a2af6b5 ("rust: pci: fix unrestricted &mut pci::Device")
Signed-off-by: Rahul Rameshbabu <sergeantsagara@protonmail.com>
Link: https://lore.kernel.org/r/20250706035944.18442-3-sergeantsagara@protonmail.com
Signed-off-by: Danilo Krummrich <dakr@kernel.org>
---

diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs
index 9afe2a8ed6372..a1febfbfc7d77 100644
--- a/rust/kernel/pci.rs
+++ b/rust/kernel/pci.rs
@@ -250,7 +250,8 @@ pub trait Driver: Send {
 ///
 /// # Invariants
 ///
-/// A [`Device`] instance represents a valid `struct device` created by the C portion of the kernel.
+/// A [`Device`] instance represents a valid `struct pci_dev` created by the C portion of the
+/// kernel.
 #[repr(transparent)]
 pub struct Device<Ctx: device::DeviceContext = device::Normal>(
     Opaque<bindings::pci_dev>,