From: Chunfeng Song <springbreeze@stu.pku.edu.cn>
To: netdev@vger.kernel.org
Cc: rust-for-linux@vger.kernel.org, fujita.tomonori@gmail.com,
kuba@kernel.org, ojeda@kernel.org, boqun@kernel.org,
andrew@lunn.ch, hkallweit1@gmail.com, stable@vger.kernel.org
Subject: [PATCH net v4] rust: net: phy: fix off-by-one bit positions in device status accessors
Date: Tue, 1 Sep 2026 03:18:24 +0000 [thread overview]
Message-ID: <20260901031824.1377498-1-springbreeze@stu.pku.edu.cn> (raw)
The hand-written bitfield offsets in is_link_up(), is_autoneg_enabled()
and is_autoneg_completed() were correct when the abstraction was
merged: at that time autoneg, link, and autoneg_complete were at bits
13, 14, and 15 of struct phy_device's first bitfield unit. Commit
2796ff1e3dca ("net: phy: add flag is_genphy_driven to struct phy_device")
later inserted is_genphy_driven just before autoneg, shifting the three
fields up by one, so the accessors now read:
is_link_up() reads bit 14 = autoneg
is_autoneg_enabled() reads bit 13 = is_genphy_driven
is_autoneg_completed() reads bit 15 = link
The official ax88796b Rust driver uses all three accessors in its
link-change handling, so it inherits the bug. On genphy-driven devices
is_genphy_driven is always 1, which masks the broken
is_autoneg_enabled() check.
The ordinary bindgen accessors take &self. Calling them through
(*phydev).link() would create a shared reference to the complete
bindings::phy_device, which is not appropriate for an object wrapped in
Opaque.
Use the bindgen-generated raw accessors (link_raw(), autoneg_raw(),
and autoneg_complete_raw()) instead. They retain the bit positions and
endianness handling generated from the C layout without creating a Rust
reference to the complete phy_device. Drop the hand-written numbers
together with the TODO comment that marked them as a stopgap.
Found by a static equivalence audit (C2RustDrv, a C-to-Rust driver
migration tool) that compares hand-written bitfield offsets against
the bindgen layout of struct phy_device. Verified by building the
bindings and checking the generated accessors; no runtime testing was
possible without PHY hardware.
Fixes: 2796ff1e3dca ("net: phy: add flag is_genphy_driven to struct phy_device")
Cc: stable@vger.kernel.org
Signed-off-by: Chunfeng Song <springbreeze@stu.pku.edu.cn>
---
v4:
- Use the bindgen-generated raw accessors to avoid creating a shared
reference to the complete C `phy_device`, as suggested by Jakub Kicinski.
- Update the SAFETY comments to describe pointer validity and the
callback-context preconditions.
- Add `#[inline]` to the three small forwarding methods.
v3: https://lore.kernel.org/r/20260825111334.795732-1-springbreeze@stu.pku.edu.cn/
- Use the bindgen-generated accessors instead of hard-coded bit numbers.
- Update the Fixes tag and add the net tree subject prefix.
v2: https://lore.kernel.org/r/20260824111227.742645-1-springbreeze@stu.pku.edu.cn/
- Use bindgen-generated accessors as suggested by Andrew Lunn.
- Explain that the offsets drifted after `is_genphy_driven` was added.
v1: https://lore.kernel.org/r/20260823103644.342849-1-springbreeze@stu.pku.edu.cn/
rust/kernel/net/phy.rs | 43 ++++++++++++++++++++++--------------------
1 file changed, 23 insertions(+), 20 deletions(-)
diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
index 956cda573ddb..3f1c1637f027 100644
--- a/rust/kernel/net/phy.rs
+++ b/rust/kernel/net/phy.rs
@@ -123,39 +123,42 @@ pub fn state(&self) -> DeviceState {
/// Gets the current link state.
///
/// It returns true if the link is up.
+ #[inline]
pub fn is_link_up(&self) -> bool {
- const LINK_IS_UP: u64 = 1;
- // TODO: the code to access to the bit field will be replaced with automatically
- // generated code by bindgen when it becomes possible.
- // SAFETY: The struct invariant ensures that we may access
- // this field without additional synchronization.
- let bit_field = unsafe { &(*self.0.get())._bitfield_1 };
- bit_field.get(14, 1) == LINK_IS_UP
+ let phydev = self.0.get().cast_const();
+ // SAFETY: By the type invariant of `Device`, `phydev` points to a valid
+ // `struct phy_device`, and the caller is in a context where this access
+ // is safe. The bindgen raw accessor does not create a Rust reference to
+ // the C struct.
+ unsafe { bindings::phy_device::link_raw(phydev) == 1 }
}
/// Gets the current auto-negotiation configuration.
///
/// It returns true if auto-negotiation is enabled.
+ #[inline]
pub fn is_autoneg_enabled(&self) -> bool {
- // TODO: the code to access to the bit field will be replaced with automatically
- // generated code by bindgen when it becomes possible.
- // SAFETY: The struct invariant ensures that we may access
- // this field without additional synchronization.
- let bit_field = unsafe { &(*self.0.get())._bitfield_1 };
- bit_field.get(13, 1) == u64::from(bindings::AUTONEG_ENABLE)
+ let phydev = self.0.get().cast_const();
+ // SAFETY: By the type invariant of `Device`, `phydev` points to a valid
+ // `struct phy_device`, and the caller is in a context where this access
+ // is safe. The bindgen raw accessor does not create a Rust reference to
+ // the C struct.
+ unsafe {
+ bindings::phy_device::autoneg_raw(phydev) == bindings::AUTONEG_ENABLE
+ }
}
/// Gets the current auto-negotiation state.
///
/// It returns true if auto-negotiation is completed.
+ #[inline]
pub fn is_autoneg_completed(&self) -> bool {
- const AUTONEG_COMPLETED: u64 = 1;
- // TODO: the code to access to the bit field will be replaced with automatically
- // generated code by bindgen when it becomes possible.
- // SAFETY: The struct invariant ensures that we may access
- // this field without additional synchronization.
- let bit_field = unsafe { &(*self.0.get())._bitfield_1 };
- bit_field.get(15, 1) == AUTONEG_COMPLETED
+ let phydev = self.0.get().cast_const();
+ // SAFETY: By the type invariant of `Device`, `phydev` points to a valid
+ // `struct phy_device`, and the caller is in a context where this access
+ // is safe. The bindgen raw accessor does not create a Rust reference to
+ // the C struct.
+ unsafe { bindings::phy_device::autoneg_complete_raw(phydev) == 1 }
}
/// Sets the speed of the PHY.
base-commit: 2709dd5ae32f0828f386327c76bba9f39f63a1c6
--
2.43.0
next reply other threads:[~2026-09-01 3:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-01 3:18 Chunfeng Song [this message]
2026-09-01 12:03 ` [PATCH net v4] rust: net: phy: fix off-by-one bit positions in device status accessors Gary Guo
2026-09-01 12:47 ` Miguel Ojeda
2026-09-01 12:48 ` Miguel Ojeda
2026-09-01 14:44 ` Chunfeng Song
2026-09-01 15:06 ` Miguel Ojeda
2026-09-01 12:48 ` Andrew Lunn
2026-09-01 12:51 ` Miguel Ojeda
2026-09-01 15:52 ` Greg KH
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=20260901031824.1377498-1-springbreeze@stu.pku.edu.cn \
--to=springbreeze@stu.pku.edu.cn \
--cc=andrew@lunn.ch \
--cc=boqun@kernel.org \
--cc=fujita.tomonori@gmail.com \
--cc=hkallweit1@gmail.com \
--cc=kuba@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=stable@vger.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