[net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Christian Marangi]

Validate PHY LED OPs presence before registering and parsing them.
Defining LED nodes for a PHY driver that actually doesn't supports them
is redundant and useless.

It's also the case with Generic PHY driver used and a DT having LEDs
node for the specific PHY.

Skip it and report the error with debug print enabled.

Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
---
Changes v2:
- Use phydev_dbg instead of warn

 drivers/net/phy/phy_device.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/drivers/net/phy/phy_device.c b/drivers/net/phy/phy_device.c
index 499797646580..e3aff78945a2 100644
--- a/drivers/net/phy/phy_device.c
+++ b/drivers/net/phy/phy_device.c
@@ -3421,6 +3421,16 @@ static int of_phy_leds(struct phy_device *phydev)
 	if (!leds)
 		return 0;
 
+	/* Check if the PHY driver have at least an OP to
+	 * set the LEDs.
+	 */
+	if (!phydev->drv->led_brightness_set &&
+	    !phydev->drv->led_blink_set &&
+	    !phydev->drv->led_hw_control_set) {
+		phydev_dbg(phydev, "ignoring leds node defined with no PHY driver support\n");
+		goto exit;
+	}
+
 	for_each_available_child_of_node_scoped(leds, led) {
 		err = of_phy_led(phydev, led);
 		if (err) {
@@ -3430,6 +3440,7 @@ static int of_phy_leds(struct phy_device *phydev)
 		}
 	}
 
+exit:
 	of_node_put(leds);
 	return 0;
 }
-- 
2.45.2

Re: [net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Andrew Lunn]

> +	/* Check if the PHY driver have at least an OP to
> +	 * set the LEDs.
> +	 */
> +	if (!phydev->drv->led_brightness_set &&
> +	    !phydev->drv->led_blink_set &&
> +	    !phydev->drv->led_hw_control_set) {

I think this condition is too strong. All that should be required is
led_brightness_set(). The rest can be done in software.


    Andrew

---
pw-bot: cr

Re: [net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Daniel Golle]

On Tue, Oct 08, 2024 at 03:08:32PM +0200, Andrew Lunn wrote:
> > +	/* Check if the PHY driver have at least an OP to
> > +	 * set the LEDs.
> > +	 */
> > +	if (!phydev->drv->led_brightness_set &&
> > +	    !phydev->drv->led_blink_set &&
> > +	    !phydev->drv->led_hw_control_set) {
> 
> I think this condition is too strong. All that should be required is
> led_brightness_set(). The rest can be done in software.

Some drivers do not offer led_brightness_set().
See for example
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/net/phy/realtek.c#n1303

Afaik there aren't any drivers which only offer led_blink_set(), that
would indeed be a bit weird. But only offering led_hw_control_set() is a
(rather sad) reality.

Re: [net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Christian Marangi]

On Tue, Oct 08, 2024 at 03:08:32PM +0200, Andrew Lunn wrote:
> > +	/* Check if the PHY driver have at least an OP to
> > +	 * set the LEDs.
> > +	 */
> > +	if (!phydev->drv->led_brightness_set &&
> > +	    !phydev->drv->led_blink_set &&
> > +	    !phydev->drv->led_hw_control_set) {
> 
> I think this condition is too strong. All that should be required is
> led_brightness_set(). The rest can be done in software.
>

Mhh the idea was really to check if one of the 3 is declared. Ideally to
future proof case where some led will only expose led_hw_control_set or
only led_blink_set?

-- 
	Ansuel

Re: [net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Andrew Lunn]

On Tue, Oct 08, 2024 at 03:13:34PM +0200, Christian Marangi wrote:
> On Tue, Oct 08, 2024 at 03:08:32PM +0200, Andrew Lunn wrote:
> > > +	/* Check if the PHY driver have at least an OP to
> > > +	 * set the LEDs.
> > > +	 */
> > > +	if (!phydev->drv->led_brightness_set &&
> > > +	    !phydev->drv->led_blink_set &&
> > > +	    !phydev->drv->led_hw_control_set) {
> > 
> > I think this condition is too strong. All that should be required is
> > led_brightness_set(). The rest can be done in software.
> >
> 
> Mhh the idea was really to check if one of the 3 is declared. Ideally to
> future proof case where some led will only expose led_hw_control_set or
> only led_blink_set?

Ah, i read it wrong. Sorry.

Maybe apply De Morgan's laws to make it more readable?

+	if (!(phydev->drv->led_brightness_set ||
+	      phydev->drv->led_blink_set ||
+	      phydev->drv->led_hw_control_set)) {

However, it is correct as is.

    Andrew

Re: [net-next PATCH v2] net: phy: Validate PHY LED OPs presence before registering

[Christian Marangi]

On Tue, Oct 08, 2024 at 07:02:18PM +0200, Andrew Lunn wrote:
> On Tue, Oct 08, 2024 at 03:13:34PM +0200, Christian Marangi wrote:
> > On Tue, Oct 08, 2024 at 03:08:32PM +0200, Andrew Lunn wrote:
> > > > +	/* Check if the PHY driver have at least an OP to
> > > > +	 * set the LEDs.
> > > > +	 */
> > > > +	if (!phydev->drv->led_brightness_set &&
> > > > +	    !phydev->drv->led_blink_set &&
> > > > +	    !phydev->drv->led_hw_control_set) {
> > > 
> > > I think this condition is too strong. All that should be required is
> > > led_brightness_set(). The rest can be done in software.
> > >
> > 
> > Mhh the idea was really to check if one of the 3 is declared. Ideally to
> > future proof case where some led will only expose led_hw_control_set or
> > only led_blink_set?
> 
> Ah, i read it wrong. Sorry.
> 
> Maybe apply De Morgan's laws to make it more readable?
> 
> +	if (!(phydev->drv->led_brightness_set ||
> +	      phydev->drv->led_blink_set ||
> +	      phydev->drv->led_hw_control_set)) {
> 
> However, it is correct as is.
>

Happy to send v3. Np!

-- 
	Ansuel