rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Benno Lossin <benno.lossin@proton.me>
To: FUJITA Tomonori <fujita.tomonori@gmail.com>,
	rust-for-linux@vger.kernel.org
Cc: andrew@lunn.ch
Subject: Re: [RFC PATCH v1 1/4] rust: core abstractions for network PHY drivers
Date: Mon, 18 Sep 2023 10:22:22 +0000	[thread overview]
Message-ID: <532b57ad-6d35-f0ee-1433-b9b63a91fdd5@proton.me> (raw)
In-Reply-To: <20230913133609.1668758-2-fujita.tomonori@gmail.com>

 > This patch adds abstractions to implement network PHY drivers; the
 > driver registration and bindings for some of callback functions in
 > struct phy_driver and many genphy_ functions.
 >
 > Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
 > ---
 >  rust/bindings/bindings_helper.h |   3 +
 >  rust/kernel/lib.rs              |   2 +
 >  rust/kernel/net.rs              |   6 +
 >  rust/kernel/net/phy.rs          | 651 ++++++++++++++++++++++++++++++++
 >  4 files changed, 662 insertions(+)
 >  create mode 100644 rust/kernel/net.rs
 >  create mode 100644 rust/kernel/net/phy.rs
 >
 > diff --git a/rust/bindings/bindings_helper.h 
b/rust/bindings/bindings_helper.h
 > index c91a3c24f607..ec4ee09a34ad 100644
 > --- a/rust/bindings/bindings_helper.h
 > +++ b/rust/bindings/bindings_helper.h
 > @@ -8,6 +8,9 @@
 >
 >  #include <kunit/test.h>
 >  #include <linux/errname.h>
 > +#include <linux/ethtool.h>
 > +#include <linux/mdio.h>
 > +#include <linux/phy.h>
 >  #include <linux/slab.h>
 >  #include <linux/refcount.h>
 >  #include <linux/wait.h>
 > diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
 > index e8811700239a..e84fa513dfda 100644
 > --- a/rust/kernel/lib.rs
 > +++ b/rust/kernel/lib.rs
 > @@ -36,6 +36,8 @@
 >  pub mod ioctl;
 >  #[cfg(CONFIG_KUNIT)]
 >  pub mod kunit;
 > +#[cfg(CONFIG_NET)]
 > +pub mod net;
 >  pub mod prelude;
 >  pub mod print;
 >  mod static_assert;
 > diff --git a/rust/kernel/net.rs b/rust/kernel/net.rs
 > new file mode 100644
 > index 000000000000..b49b052969e5
 > --- /dev/null
 > +++ b/rust/kernel/net.rs
 > @@ -0,0 +1,6 @@
 > +// SPDX-License-Identifier: GPL-2.0
 > +
 > +//! Networking.
 > +
 > +#[cfg(CONFIG_PHYLIB)]
 > +pub mod phy;
 > diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
 > new file mode 100644
 > index 000000000000..2c5ac5e3213a
 > --- /dev/null
 > +++ b/rust/kernel/net/phy.rs
 > @@ -0,0 +1,651 @@
 > +// SPDX-License-Identifier: GPL-2.0
 > +
 > +//! Network PHY device.
 > +//!
 > +//! C headers: [`include/linux/phy.h`](../../../../include/linux/phy.h).
 > +
 > +use crate::{bindings, error::*, prelude::vtable, prelude::Box, 
str::CStr, types::Opaque};
 > +use core::marker::PhantomData;
 > +
 > +/// Corresponds to the kernel's `enum phy_state`.
 > +#[derive(PartialEq)]
 > +pub enum DeviceState {
 > +    /// PHY device and driver are not ready for anything.
 > +    Down,
 > +    /// PHY is ready to send and receive packets.
 > +    Ready,
 > +    /// PHY is up, but no polling or interrupts are done.
 > +    Halted,
 > +    /// PHY is up, but is in an error state.
 > +    Error,
 > +    /// PHY and attached device are ready to do work.
 > +    Up,
 > +    /// PHY is currently running.
 > +    Running,
 > +    /// PHY is up, but not currently plugged in.
 > +    NoLink,
 > +    /// PHY is performing a cable test.
 > +    CableTest,
 > +    /// Unknown, not defined in the kernel.
 > +    Unknown,
 > +}
 > +
 > +/// Wraps the kernel's `struct phy_device`.
 > +#[repr(transparent)]
 > +pub struct Device(Opaque<bindings::phy_device>);
 > +
 > +impl Device {
 > +    /// Creates a new [`Device`] instance from a raw pointer.
 > +    ///
 > +    /// # Safety
 > +    ///
 > +    /// For the duration of the lifetime 'a, the pointer must be 
valid for writing and nobody else
 > +    /// may read or write to the `phy_device` object.
 > +    pub unsafe fn from_raw<'a>(ptr: *mut bindings::phy_device) -> 
&'a mut Self {
 > +        unsafe { &mut *(ptr as *mut Self) }
 > +    }
 > +
 > +    /// Gets the id of the PHY.
 > +    pub fn id(&mut self) -> u32 {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe { (*phydev).phy_id }
 > +    }
 > +
 > +    /// Returns true if the PHY has no link.
 > +    pub fn link(&mut self) -> bool {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe { (*phydev).link() != 0 }
 > +    }
 > +
 > +    /// Gets the state of the PHY.
 > +    pub fn state(&mut self) -> DeviceState {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        let state = unsafe { (*phydev).state };
 > +        match state {
 > +            0 => DeviceState::Down,
 > +            1 => DeviceState::Ready,
 > +            2 => DeviceState::Halted,
 > +            3 => DeviceState::Error,
 > +            4 => DeviceState::Up,
 > +            5 => DeviceState::Running,
 > +            6 => DeviceState::NoLink,
 > +            7 => DeviceState::CableTest,
 > +            _ => DeviceState::Unknown,
 > +        }
 > +    }
 > +
 > +    /// Returns true if auto-negotiation is enabled.
 > +    pub fn is_autoneg_enabled(&mut self) -> bool {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe { (*phydev).autoneg() == bindings::AUTONEG_ENABLE }
 > +    }
 > +
 > +    /// Returns true if auto-negotiation is completed.
 > +    pub fn is_autoneg_completed(&mut self) -> bool {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe { (*phydev).autoneg_complete() != 0 }
 > +    }
 > +
 > +    /// Sets the speed of the PHY.
 > +    pub fn set_speed(&mut self, speed: i32) {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe {
 > +            (*phydev).speed = speed;
 > +        }
 > +    }
 > +
 > +    /// Sets duplex mode.
 > +    pub fn set_duplex(&mut self, is_full: bool) {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor, so it's valid.
 > +        unsafe {
 > +            if is_full {
 > +                (*phydev).duplex = bindings::DUPLEX_FULL as i32;
 > +            } else {
 > +                (*phydev).duplex = bindings::DUPLEX_HALF as i32;
 > +            }
 > +        }
 > +    }
 > +
 > +    /// Executes software reset the PHY via BMCR_RESET bit.
 > +    pub fn soft_reset(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_soft_reset(phydev) };
 > +        if ret < 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Reads a given PHY register.
 > +    pub fn read(&mut self, regnum: u32) -> Result<i32> {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret =
 > +            unsafe { bindings::mdiobus_read((*phydev).mdio.bus, 
(*phydev).mdio.addr, regnum) };
 > +        if ret < 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(ret)
 > +        }
 > +    }
 > +
 > +    /// Writes a given PHY register.
 > +    pub fn write(&mut self, regnum: u32, val: u16) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe {
 > +            bindings::mdiobus_write((*phydev).mdio.bus, 
(*phydev).mdio.addr, regnum, val)
 > +        };
 > +        if ret < 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Reads a given PHY register without the MDIO bus lock taken.
 > +    pub fn lockless_read(&mut self, regnum: u32) -> Result<i32> {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret =
 > +            unsafe { bindings::__mdiobus_read((*phydev).mdio.bus, 
(*phydev).mdio.addr, regnum) };
 > +        if ret < 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(ret)
 > +        }
 > +    }
 > +
 > +    /// Writes a given PHY register without the MDIO bus lock taken.
 > +    pub fn lockless_write(&mut self, regnum: u32, val: u16) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe {
 > +            bindings::__mdiobus_write((*phydev).mdio.bus, 
(*phydev).mdio.addr, regnum, val)
 > +        };
 > +        if ret < 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Resumes the PHY via BMCR_PDOWN bit.
 > +    pub fn resume(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_resume(phydev) };
 > +        if ret != 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Suspends the PHY via BMCR_PDOWN bit.
 > +    pub fn suspend(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_suspend(phydev) };
 > +        if ret != 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Checks the link status and updates current link state.
 > +    pub fn read_status(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_read_status(phydev) };
 > +        if ret != 0 {
 > +            Err(Error::from_errno(ret))
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Reads a paged register.
 > +    pub fn read_paged(&mut self, page: i32, regnum: u32) -> 
Result<i32> {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::phy_read_paged(phydev, page, 
regnum) };
 > +        if ret < 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(ret)
 > +        }
 > +    }
 > +
 > +    /// Updates the link status.
 > +    pub fn update_link(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_update_link(phydev) };
 > +        if ret < 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Reads Link partner ability.
 > +    pub fn read_lpa(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_read_lpa(phydev) };
 > +        if ret < 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Resolves the advertisements into PHY settings.
 > +    pub fn resolve_aneg_linkmode(&mut self) {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        unsafe {
 > +            bindings::phy_resolve_aneg_linkmode(phydev);
 > +        }
 > +    }
 > +
 > +    /// Initializes the PHY.
 > +    pub fn init_hw(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::phy_init_hw(phydev) };
 > +        if ret != 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Starts auto-negotiation.
 > +    pub fn start_aneg(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::phy_start_aneg(phydev) };
 > +        if ret != 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +
 > +    /// Reads PHY abilities from Clause 22 registers.
 > +    pub fn read_abilities(&mut self) -> Result {
 > +        let phydev = Opaque::get(&self.0);
 > +        // SAFETY: This object is initialized by the `from_raw` 
constructor,
 > +        // so an FFI call with a valid pointer.
 > +        let ret = unsafe { bindings::genphy_read_abilities(phydev) };
 > +        if ret != 0 {
 > +            return Err(Error::from_errno(ret));
 > +        } else {
 > +            Ok(())
 > +        }
 > +    }
 > +}
 > +
 > +/// PHY is internal.
 > +pub const PHY_IS_INTERNAL: u32 = 0x00000001;
 > +/// PHY needs to be reset after the refclk is enabled.
 > +pub const PHY_RST_AFTER_CLK_EN: u32 = 0x00000002;
 > +/// Polling is used to detect PHY status changes.
 > +pub const PHY_POLL_CABLE_TEST: u32 = 0x00000004;
 > +/// Don't suspend.
 > +pub const PHY_ALWAYS_CALL_SUSPEND: u32 = 0x00000008;

I think we should create a macro for creating flags, it should create a 
newtype and
work similar to an enum declaration. On the newtype it should implement 
the `Or` trait
for allowing `PHY_IS_INTERNAL | PHY_RST_AFTER_CLK_EN`.

 > +
 > +/// An adapter for the registration of a PHY driver.
 > +pub struct Adapter<T: Driver> {
 > +    name: &'static CStr,
 > +    _p: PhantomData<T>,
 > +}
 > +
 > +impl<T: Driver> Adapter<T> {
 > +    /// Creates a new `Adapter` instance.
 > +    pub const fn new(name: &'static CStr) -> Adapter<T> {
 > +        Self {
 > +            name,
 > +            _p: PhantomData,
 > +        }
 > +    }
 > +
 > +    unsafe extern "C" fn soft_reset_callback(
 > +        phydev: *mut bindings::phy_device,
 > +    ) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::soft_reset(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn get_features_callback(
 > +        phydev: *mut bindings::phy_device,
 > +    ) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::get_features(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn suspend_callback(phydev: *mut 
bindings::phy_device) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::suspend(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn resume_callback(phydev: *mut 
bindings::phy_device) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::resume(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn config_aneg_callback(
 > +        phydev: *mut bindings::phy_device,
 > +    ) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::config_aneg(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn read_page_callback(phydev: *mut 
bindings::phy_device) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            let ret = T::read_page(dev)?;
 > +            Ok(ret)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn write_page_callback(
 > +        phydev: *mut bindings::phy_device,
 > +        page: i32,
 > +    ) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::write_page(dev, page)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn read_status_callback(
 > +        phydev: *mut bindings::phy_device,
 > +    ) -> core::ffi::c_int {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::read_status(dev)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn match_phy_device_callback(
 > +        phydev: *mut bindings::phy_device,
 > +    ) -> core::ffi::c_int {
 > +        // SAFETY: The C API guarantees that `phydev` is valid while 
this function is running.
 > +        let dev = unsafe { Device::from_raw(phydev) };
 > +        T::match_phy_device(dev) as i32
 > +    }
 > +
 > +    unsafe extern "C" fn read_mmd_callback(
 > +        phydev: *mut bindings::phy_device,
 > +        devnum: i32,
 > +        regnum: u16,
 > +    ) -> i32 {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            let ret = T::read_mmd(dev, devnum, regnum)?;
 > +            Ok(ret)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn write_mmd_callback(
 > +        phydev: *mut bindings::phy_device,
 > +        devnum: i32,
 > +        regnum: u16,
 > +        val: u16,
 > +    ) -> i32 {
 > +        from_result(|| {
 > +            // SAFETY: The C API guarantees that `phydev` is valid 
while this function is running.
 > +            let dev = unsafe { Device::from_raw(phydev) };
 > +            T::write_mmd(dev, devnum, regnum, val)?;
 > +            Ok(0)
 > +        })
 > +    }
 > +
 > +    unsafe extern "C" fn link_change_notify_callback(phydev: *mut 
bindings::phy_device) {
 > +        // SAFETY: The C API guarantees that `phydev` is valid while 
this function is running.
 > +        let dev = unsafe { Device::from_raw(phydev) };
 > +        T::link_change_notify(dev);
 > +    }
 > +
 > +    fn driver(&self) -> bindings::phy_driver {
 > +        bindings::phy_driver {
 > +            name: self.name.as_char_ptr() as *mut i8,
 > +            flags: <T>::FLAGS,
 > +            soft_reset: if <T>::HAS_SOFT_RESET {
 > +                Some(Self::soft_reset_callback)
 > +            } else {
 > +                None
 > +            },
 > +            get_features: if <T>::HAS_GET_FEATURES {
 > +                Some(Self::get_features_callback)
 > +            } else {
 > +                None
 > +            },
 > +            match_phy_device: if <T>::HAS_MATCH_PHY_DEVICE {
 > +                Some(Self::match_phy_device_callback)
 > +            } else {
 > +                None
 > +            },
 > +            suspend: if <T>::HAS_SUSPEND {
 > +                Some(Self::suspend_callback)
 > +            } else {
 > +                None
 > +            },
 > +            resume: if <T>::HAS_RESUME {
 > +                Some(Self::resume_callback)
 > +            } else {
 > +                None
 > +            },
 > +            config_aneg: if <T>::HAS_CONFIG_ANEG {
 > +                Some(Self::config_aneg_callback)
 > +            } else {
 > +                None
 > +            },
 > +            read_status: if <T>::HAS_READ_STATUS {
 > +                Some(Self::read_status_callback)
 > +            } else {
 > +                None
 > +            },
 > +            read_page: if <T>::HAS_READ_PAGE {
 > +                Some(Self::read_page_callback)
 > +            } else {
 > +                None
 > +            },
 > +            write_page: if <T>::HAS_WRITE_PAGE {
 > +                Some(Self::write_page_callback)
 > +            } else {
 > +                None
 > +            },
 > +            read_mmd: if <T>::HAS_READ_MMD {
 > +                Some(Self::read_mmd_callback)
 > +            } else {
 > +                None
 > +            },
 > +            write_mmd: if <T>::HAS_WRITE_MMD {
 > +                Some(Self::write_mmd_callback)
 > +            } else {
 > +                None
 > +            },
 > +            link_change_notify: if <T>::HAS_LINK_CHANGE_NOTIFY {
 > +                Some(Self::link_change_notify_callback)
 > +            } else {
 > +                None
 > +            },
 > +            ..unsafe { 
core::mem::MaybeUninit::<bindings::phy_driver>::zeroed().assume_init() }
 > +        }
 > +    }
 > +}
 > +
 > +/// Corresponds to functions in `struct phy_driver`.
 > +#[vtable]
 > +pub trait Driver {
 > +    /// Corresponds to `flags` in `struct phy_driver`.
 > +    const FLAGS: u32 = 0;
 > +
 > +    /// Corresponds to `soft_reset` in `struct phy_driver`.
 > +    fn soft_reset(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `get_features` in `struct phy_driver`.
 > +    fn get_features(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `match_phy_device` in `struct phy_driver`.
 > +    fn match_phy_device(_dev: &mut Device) -> bool;
 > +
 > +    /// Corresponds to `config_aneg` in `struct phy_driver`.
 > +    fn config_aneg(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `read_page` in `struct phy_driver`.
 > +    fn read_page(_dev: &mut Device) -> Result<i32> {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `write_page` in `struct phy_driver`.
 > +    fn write_page(_dev: &mut Device, _page: i32) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `read_status` in `struct phy_driver`.
 > +    fn read_status(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `suspend` in `struct phy_driver`.
 > +    fn suspend(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `resume` in `struct phy_driver`.
 > +    fn resume(_dev: &mut Device) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `read_mmd` in `struct phy_driver`.
 > +    fn read_mmd(_dev: &mut Device, _devnum: i32, _regnum: u16) -> 
Result<i32> {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `write_mmd` in `struct phy_driver`.
 > +    fn write_mmd(_dev: &mut Device, _devnum: i32, _regnum: u16, 
_val: u16) -> Result {
 > +        Err(code::ENOTSUPP)
 > +    }
 > +
 > +    /// Corresponds to `link_change_notify` in `struct phy_driver`.
 > +    fn link_change_notify(_dev: &mut Device) {}
 > +}
 > +
 > +/// Registration structure for a PHY driver.
 > +///
 > +/// `Registration` can keep multiple `phy_drivers` object because
 > +/// commonly one module implements multiple PHYs drivers.
 > +pub struct Registration<const N: usize> {
 > +    module: &'static crate::ThisModule,
 > +    drivers: [Option<Box<bindings::phy_driver>>; N],

Why is this not a vector? You have to allocate in `register` anyways.
You could also use `Vec::try_with_capacity(N)` to initialize the vector with
capacity for N elements.

 > +}
 > +
 > +impl<const N: usize> Registration<{ N }> {
 > +    /// Creates a new `Registration` instance.
 > +    pub fn new(module: &'static crate::ThisModule) -> Self {
 > +        const NONE: Option<Box<bindings::phy_driver>> = None;
 > +        Registration {
 > +            module,
 > +            drivers: [NONE; N],
 > +        }
 > +    }
 > +
 > +    /// Registers a PHY driver.
 > +    pub fn register<T: Driver>(&mut self, adapter: &Adapter<T>) -> 
Result {

The way this function is used in the driver makes me think that the 
`Adapter`
type does not have to be public. So I would suggest to change the 
signature to
`pub fn register<T: Driver>(&mut self, name: &'static CStr) -> Result`.


 > +        for i in 0..N {
 > +            if self.drivers[i].is_none() {
 > +                let mut drv = Box::try_new(adapter.driver())?;
 > +                // SAFETY: Just an FFI call.
 > +                let ret = unsafe { 
bindings::phy_driver_register(drv.as_mut(), self.module.0) };

This call exposes the driver to the C side and thus it is able to be 
modified at any time,
which means that in Rust it should be put into an `UnsafeCell`, better 
even in this case it
should just be `Opaque`, so the `drivers` fields should be of type
`[Option<Box<Opaque<bindings::phy_driver>>>]`.
It would also be a good idea to pin it, since the C side will rely on 
the pointee not moving
and it will prevent accidentally moving it.

 > +                if ret != 0 {
 > +                    return Err(Error::from_errno(ret));
 > +                }
 > +                self.drivers[i] = Some(drv);
 > +                return Ok(());
 > +            }
 > +        }
 > +        Err(code::EINVAL)
 > +    }
 > +}
 > +
 > +impl<const N: usize> Drop for Registration<{ N }> {
 > +    fn drop(&mut self) {
 > +        for i in 0..N {
 > +            if let Some(mut drv) = self.drivers[i].take() {
 > +                unsafe {
 > +                    // SAFETY: Just an FFI call.
 > +                    bindings::phy_driver_unregister(drv.as_mut());
 > +                }
 > +            } else {
 > +                break;
 > +            }
 > +        }
 > +    }
 > +}
 > +
 > +// SAFETY: `Registration` does not expose any of its state across 
threads.
 > +unsafe impl<const N: usize> Send for Registration<{ N }> {}
 > +
 > +// SAFETY: `Registration` does not expose any of its state across 
threads.
 > +unsafe impl<const N: usize> Sync for Registration<{ N }> {}
 > --
 > 2.34.1
 >
 >


  parent reply	other threads:[~2023-09-18 10:22 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-13 13:36 [RFC PATCH v1 0/4] Rust abstractions for network PHY drivers FUJITA Tomonori
2023-09-13 13:36 ` [RFC PATCH v1 1/4] rust: core " FUJITA Tomonori
2023-09-13 20:11   ` Andrew Lunn
2023-09-13 20:49     ` Boqun Feng
2023-09-13 21:05       ` Andrew Lunn
2023-09-13 21:32         ` Boqun Feng
2023-09-14  4:10           ` Trevor Gross
2023-09-13 22:14     ` Miguel Ojeda
2023-09-14  0:30       ` Andrew Lunn
2023-09-14 11:03         ` Miguel Ojeda
2023-09-14 12:24           ` Andrew Lunn
2023-09-17  9:44           ` FUJITA Tomonori
2023-09-17 10:17     ` FUJITA Tomonori
2023-09-17 15:06       ` Andrew Lunn
2023-09-17 18:42         ` Trevor Gross
2023-09-17 19:08           ` Andrew Lunn
2023-09-18  0:49             ` Trevor Gross
2023-09-18  1:18               ` Andrew Lunn
2023-09-18  2:22                 ` Trevor Gross
2023-09-18  3:44                   ` FUJITA Tomonori
2023-09-18 13:13                     ` Andrew Lunn
2023-09-18  6:01         ` FUJITA Tomonori
2023-09-14  5:47   ` Trevor Gross
2023-09-14 10:17     ` Jarkko Sakkinen
2023-09-14 19:46       ` Trevor Gross
2023-09-14 12:39     ` Andrew Lunn
2023-09-14 19:42       ` Trevor Gross
2023-09-14 19:53         ` Trevor Gross
2023-09-18  9:56   ` Finn Behrens
2023-09-18 13:22     ` Andrew Lunn
2023-09-18 10:22   ` Benno Lossin [this message]
2023-09-18 13:09     ` FUJITA Tomonori
2023-09-18 15:20       ` Benno Lossin
2023-09-19 10:26         ` FUJITA Tomonori
2023-09-20 13:24           ` Benno Lossin
2023-09-13 13:36 ` [RFC PATCH v1 2/4] rust: phy: add module device table support FUJITA Tomonori
2023-09-14  6:26   ` Trevor Gross
2023-09-14  7:23     ` Trevor Gross
2023-09-17  6:30       ` FUJITA Tomonori
2023-09-17 15:13         ` Andrew Lunn
2023-09-13 13:36 ` [RFC PATCH v1 3/4] MAINTAINERS: add Rust PHY abstractions file to the ETHERNET PHY LIBRARY FUJITA Tomonori
2023-09-13 18:57   ` Andrew Lunn
2023-09-17 12:32     ` FUJITA Tomonori
2023-09-19 12:06       ` Miguel Ojeda
2023-09-19 16:33         ` Andrew Lunn
2023-09-22 23:17           ` Trevor Gross
2023-09-23  0:05           ` Miguel Ojeda
2023-09-23  1:36             ` Andrew Lunn
2023-09-23 10:19               ` Miguel Ojeda
2023-09-23 14:42                 ` Andrew Lunn
2023-10-09 12:26                   ` Miguel Ojeda
2023-09-13 13:36 ` [RFC PATCH v1 4/4] sample: rust: add Asix PHY driver FUJITA Tomonori
2023-09-13 14:11   ` Andrew Lunn
2023-09-13 16:53     ` Greg KH
2023-09-13 18:50       ` Andrew Lunn
2023-09-13 18:59         ` Greg KH
2023-09-13 20:20           ` Andrew Lunn
2023-09-13 20:38             ` Greg KH
2023-09-13 16:56   ` Greg KH
2023-09-13 18:43     ` Andrew Lunn
2023-09-13 19:15   ` Andrew Lunn
2023-09-17 11:28     ` FUJITA Tomonori
2023-09-17 15:46       ` Andrew Lunn
2023-09-18  8:35         ` FUJITA Tomonori
2023-09-18 13:37           ` Andrew Lunn
2023-09-24  9:12             ` FUJITA Tomonori
2023-09-24  9:59               ` Miguel Ojeda
2023-09-24 15:31               ` Andrew Lunn
2023-09-24 17:31                 ` Miguel Ojeda
2023-09-24 17:44                   ` Andrew Lunn
2023-09-24 18:44                     ` Miguel Ojeda
2023-09-18 22:23 ` [RFC PATCH v1 0/4] Rust abstractions for network PHY drivers Trevor Gross
2023-09-18 22:48   ` Andrew Lunn
2023-09-18 23:46     ` Trevor Gross
2023-09-19  6:24       ` FUJITA Tomonori
2023-09-19  7:41         ` Trevor Gross
2023-09-19 16:12         ` Andrew Lunn
2023-09-19  6:16   ` FUJITA Tomonori
2023-09-19  8:05     ` Trevor Gross

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=532b57ad-6d35-f0ee-1433-b9b63a91fdd5@proton.me \
    --to=benno.lossin@proton.me \
    --cc=andrew@lunn.ch \
    --cc=fujita.tomonori@gmail.com \
    --cc=rust-for-linux@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;
as well as URLs for NNTP newsgroup(s).