From: FUJITA Tomonori <fujita.tomonori@gmail.com>
To: netdev@vger.kernel.org
Cc: rust-for-linux@vger.kernel.org, andrew@lunn.ch,
tmgross@umich.edu, miguel.ojeda.sandonis@gmail.com,
benno.lossin@proton.me, aliceryhl@google.com
Subject: [PATCH net-next v5 3/6] rust: net::phy implement AsRef<kernel::device::Device> trait
Date: Mon, 19 Aug 2024 00:53:42 +0000 [thread overview]
Message-ID: <20240819005345.84255-4-fujita.tomonori@gmail.com> (raw)
In-Reply-To: <20240819005345.84255-1-fujita.tomonori@gmail.com>
Implement AsRef<kernel::device::Device> trait for Device. A PHY driver
needs a reference to device::Device to call the firmware API.
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
---
rust/kernel/net/phy.rs | 24 +++++++++++++++++-------
1 file changed, 17 insertions(+), 7 deletions(-)
diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
index 5e8137a1972f..ec337cbd391b 100644
--- a/rust/kernel/net/phy.rs
+++ b/rust/kernel/net/phy.rs
@@ -7,8 +7,7 @@
//! C headers: [`include/linux/phy.h`](srctree/include/linux/phy.h).
use crate::{error::*, prelude::*, types::Opaque};
-
-use core::marker::PhantomData;
+use core::{marker::PhantomData, ptr::addr_of_mut};
/// PHY state machine states.
///
@@ -58,8 +57,9 @@ pub enum DuplexMode {
///
/// # Invariants
///
-/// Referencing a `phy_device` using this struct asserts that you are in
-/// a context where all methods defined on this struct are safe to call.
+/// - Referencing a `phy_device` using this struct asserts that you are in
+/// a context where all methods defined on this struct are safe to call.
+/// - This struct always has a valid `self.0.mdio.dev`.
///
/// [`struct phy_device`]: srctree/include/linux/phy.h
// During the calls to most functions in [`Driver`], the C side (`PHYLIB`) holds a lock that is
@@ -76,9 +76,11 @@ impl Device {
///
/// # Safety
///
- /// For the duration of 'a, the pointer must point at a valid `phy_device`,
- /// and the caller must be in a context where all methods defined on this struct
- /// are safe to call.
+ /// For the duration of 'a,
+ /// - the pointer must point at a valid `phy_device`, and the caller
+ /// must be in a context where all methods defined on this struct
+ /// are safe to call.
+ /// - `(*ptr).mdio.dev` must be a valid.
unsafe fn from_raw<'a>(ptr: *mut bindings::phy_device) -> &'a mut Self {
// CAST: `Self` is a `repr(transparent)` wrapper around `bindings::phy_device`.
let ptr = ptr.cast::<Self>();
@@ -302,6 +304,14 @@ pub fn genphy_read_abilities(&mut self) -> Result {
}
}
+impl AsRef<kernel::device::Device> for Device {
+ fn as_ref(&self) -> &kernel::device::Device {
+ let phydev = self.0.get();
+ // SAFETY: The struct invariant ensures that `mdio.dev` is valid.
+ unsafe { kernel::device::Device::as_ref(addr_of_mut!((*phydev).mdio.dev)) }
+ }
+}
+
/// Defines certain other features this PHY supports (like interrupts).
///
/// These flag values are used in [`Driver::FLAGS`].
--
2.34.1
next prev parent reply other threads:[~2024-08-19 1:00 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-19 0:53 [PATCH net-next v5 0/6] net: phy: add Applied Micro QT2025 PHY driver FUJITA Tomonori
2024-08-19 0:53 ` [PATCH net-next v5 1/6] rust: sizes: add commonly used constants FUJITA Tomonori
2024-08-19 5:54 ` Trevor Gross
2024-08-19 0:53 ` [PATCH net-next v5 2/6] rust: net::phy support probe callback FUJITA Tomonori
2024-08-19 7:10 ` Trevor Gross
2024-08-19 0:53 ` FUJITA Tomonori [this message]
2024-08-19 7:21 ` [PATCH net-next v5 3/6] rust: net::phy implement AsRef<kernel::device::Device> trait Trevor Gross
2024-08-19 12:41 ` FUJITA Tomonori
2024-08-19 0:53 ` [PATCH net-next v5 4/6] rust: net::phy unified read/write API for C22 and C45 registers FUJITA Tomonori
2024-08-19 7:37 ` Trevor Gross
2024-08-19 12:41 ` FUJITA Tomonori
2024-08-19 0:53 ` [PATCH net-next v5 5/6] rust: net::phy unified genphy_read_status function " FUJITA Tomonori
2024-08-19 0:53 ` [PATCH net-next v5 6/6] net: phy: add Applied Micro QT2025 PHY driver FUJITA Tomonori
2024-08-19 9:07 ` Trevor Gross
2024-08-19 12:19 ` FUJITA Tomonori
2024-08-19 20:30 ` Trevor Gross
2024-08-19 22:46 ` Andrew Lunn
2024-08-20 1:07 ` FUJITA Tomonori
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=20240819005345.84255-4-fujita.tomonori@gmail.com \
--to=fujita.tomonori@gmail.com \
--cc=aliceryhl@google.com \
--cc=andrew@lunn.ch \
--cc=benno.lossin@proton.me \
--cc=miguel.ojeda.sandonis@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/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).