[RFC,net-next,v3,1/2] net: phy: phy_device Prevent nullptr exceptions on ISR

Message ID 20240119093503.6370-1-andre.werner@systec-electronic.com
State New
Headers
Series [RFC,net-next,v3,1/2] net: phy: phy_device Prevent nullptr exceptions on ISR |

Commit Message

Andre Werner Jan. 19, 2024, 9:32 a.m. UTC
  If phydev->irq is set unconditionally by MAC drivers, check
for valid interrupt handler or fall back to polling mode to prevent
nullptr exceptions.

Signed-off-by: Andre Werner <andre.werner@systec-electronic.com>
---
v3:
- No changes to v2. Just to complete the series.
---
 drivers/net/phy/phy_device.c | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)
  

Comments

Andrew Lunn Jan. 19, 2024, 1:27 p.m. UTC | #1
On Fri, Jan 19, 2024 at 10:32:25AM +0100, Andre Werner wrote:
> If phydev->irq is set unconditionally by MAC drivers, check
> for valid interrupt handler or fall back to polling mode to prevent
> nullptr exceptions.

Hi Andre

A few more process things...

Please don't post a new version within 24 hours. Reviews need time to
review, and you could miss comments made on older versions of the
patches.

For a multi part patch set, its normal to include a clover
letter. When using git format-patch add --cover-letter and than edit
patch 0000-*.patch to describe the big picture of what the patchset
does. The text will be used for the merge commit message.
 
> Signed-off-by: Andre Werner <andre.werner@systec-electronic.com>
> ---
> v3:
> - No changes to v2. Just to complete the series.
> ---
>  drivers/net/phy/phy_device.c | 22 +++++++++++++++++-----
>  1 file changed, 17 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/net/phy/phy_device.c b/drivers/net/phy/phy_device.c
> index 3611ea64875e..3986e103d25e 100644
> --- a/drivers/net/phy/phy_device.c
> +++ b/drivers/net/phy/phy_device.c
> @@ -1413,6 +1413,11 @@ int phy_sfp_probe(struct phy_device *phydev,
>  }
>  EXPORT_SYMBOL(phy_sfp_probe);
>  
> +static bool phy_drv_supports_irq(struct phy_driver *phydrv)
> +{
> +	return phydrv->config_intr && phydrv->handle_interrupt;
> +}
> +
>  /**
>   * phy_attach_direct - attach a network device to a given PHY device pointer
>   * @dev: network device to attach
> @@ -1527,6 +1532,18 @@ int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
>  	if (phydev->dev_flags & PHY_F_NO_IRQ)
>  		phydev->irq = PHY_POLL;
>  
> +	/*
> +	 * Some drivers may add IRQ numbers unconditionally to a phy device that does
> +	 * not implement an interrupt handler after phy_probe is already done.
> +	 * Reset to PHY_POLL to prevent nullptr exceptions in that case.
> +	 */
> +	if (!phy_drv_supports_irq(phydev->drv) && phy_interrupt_is_valid(phydev)) {
> +		phydev_warn(phydev,
> +			    "No handler for IRQ=%d available. Falling back to polling mode\n",
> +			    phydev->irq);
> +		phydev->irq = PHY_POLL;
> +	}

Please drop the phydev_warn(). Interrupt handling has always been
optional, and we have always silently dropped back to polling if
interrupts are not supported.

The comment wording is also not great. The MAC driver is not supposed
to have any idea what the PHY driver is. It just uses the phylib API,
which is PHY driver independent. So the MAC driver cannot tell if the
PHY driver supports interrupts or not.

I don't think a comment is needed. The code is pretty readable as is.

    Andrew

---
pw-bot: cr
  

Patch

diff --git a/drivers/net/phy/phy_device.c b/drivers/net/phy/phy_device.c
index 3611ea64875e..3986e103d25e 100644
--- a/drivers/net/phy/phy_device.c
+++ b/drivers/net/phy/phy_device.c
@@ -1413,6 +1413,11 @@  int phy_sfp_probe(struct phy_device *phydev,
 }
 EXPORT_SYMBOL(phy_sfp_probe);
 
+static bool phy_drv_supports_irq(struct phy_driver *phydrv)
+{
+	return phydrv->config_intr && phydrv->handle_interrupt;
+}
+
 /**
  * phy_attach_direct - attach a network device to a given PHY device pointer
  * @dev: network device to attach
@@ -1527,6 +1532,18 @@  int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 	if (phydev->dev_flags & PHY_F_NO_IRQ)
 		phydev->irq = PHY_POLL;
 
+	/*
+	 * Some drivers may add IRQ numbers unconditionally to a phy device that does
+	 * not implement an interrupt handler after phy_probe is already done.
+	 * Reset to PHY_POLL to prevent nullptr exceptions in that case.
+	 */
+	if (!phy_drv_supports_irq(phydev->drv) && phy_interrupt_is_valid(phydev)) {
+		phydev_warn(phydev,
+			    "No handler for IRQ=%d available. Falling back to polling mode\n",
+			    phydev->irq);
+		phydev->irq = PHY_POLL;
+	}
+
 	/* Port is set to PORT_TP by default and the actual PHY driver will set
 	 * it to different value depending on the PHY configuration. If we have
 	 * the generic PHY driver we can't figure it out, thus set the old
@@ -2992,11 +3009,6 @@  s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
 }
 EXPORT_SYMBOL(phy_get_internal_delay);
 
-static bool phy_drv_supports_irq(struct phy_driver *phydrv)
-{
-	return phydrv->config_intr && phydrv->handle_interrupt;
-}
-
 static int phy_led_set_brightness(struct led_classdev *led_cdev,
 				  enum led_brightness value)
 {