[PATCH net-next] dt-bindings: net: realtek,rtl82xx: document wakeup-source property

[PATCH net-next] dt-bindings: net: realtek,rtl82xx: document wakeup-source property

[Russell King (Oracle)]

The RTL8211F PHY has two modes for a single INTB/PMEB pin:

1. INTB mode, where it signals interrupts to the CPU, which can
   include wake-on-LAN events.
2. PMEB mode, where it only signals a wake-on-LAN event, which
   may either be a latched logic low until software manually
   clears the WoL state, or pulsed mode.

In the case of (1), there is no way to know whether the interrupt to
which the PHY is connected is capable of waking the system. In the
case of (2), there would be no interrupt property in the PHY's DT
description, and thus there is nothing to describe whether the pin is
even wired to anything such as a power management controller.

There is a "wakeup-source" property which can be applied to any device
- see Documentation/devicetree/bindings/power/wakeup-source.txt

Case 1 above matches example 2 in this document, and case 2 above
matches example 3. Therefore, it seems reasonable to make use of this
existing specification, albiet it hasn't been converted to YAML.

Document the wakeup-source property in the device description, which
will indicate that the PHY has been wired up in such a way that it
can wake the system from a low power state.

We will use this in a rewrite of the existing broken Wake-on-Lan code
that was merged during the 6.16 merge window to support case 1. Case 2
can be added to the driver later without needing to further alter the
DT description. To be clear, the existing Wake-on-Lan code that was
recently merged has multiple functional issues.

Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
---
Apologies, this should've been sent with the patch to the driver which
can be found at:

https://lore.kernel.org/r/E1um8Ld-008jxD-Mc@rmk-PC.armlinux.org.uk

 Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml b/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
index d248a08a2136..2b5697bd7c5d 100644
--- a/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
+++ b/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
@@ -45,12 +45,16 @@ title: Realtek RTL82xx PHY
     description:
       Disable CLKOUT clock, CLKOUT clock default is enabled after hardware reset.
 
-
   realtek,aldps-enable:
     type: boolean
     description:
       Enable ALDPS mode, ALDPS mode default is disabled after hardware reset.
 
+  wakeup-source:
+    type: boolean
+    description:
+      Enable Wake-on-LAN support for the RTL8211F PHY.
+
 unevaluatedProperties: false
 
 allOf:
-- 
2.30.2

Re: [PATCH net-next] dt-bindings: net: realtek,rtl82xx: document wakeup-source property

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2940 bytes --]

On Wed, Aug 13, 2025 at 12:21:19PM +0100, Russell King (Oracle) wrote:
> The RTL8211F PHY has two modes for a single INTB/PMEB pin:
> 
> 1. INTB mode, where it signals interrupts to the CPU, which can
>    include wake-on-LAN events.
> 2. PMEB mode, where it only signals a wake-on-LAN event, which
>    may either be a latched logic low until software manually
>    clears the WoL state, or pulsed mode.
> 
> In the case of (1), there is no way to know whether the interrupt to
> which the PHY is connected is capable of waking the system. In the
> case of (2), there would be no interrupt property in the PHY's DT
> description, and thus there is nothing to describe whether the pin is
> even wired to anything such as a power management controller.
> 
> There is a "wakeup-source" property which can be applied to any device
> - see Documentation/devicetree/bindings/power/wakeup-source.txt
> 
> Case 1 above matches example 2 in this document, and case 2 above
> matches example 3. Therefore, it seems reasonable to make use of this
> existing specification, albiet it hasn't been converted to YAML.
> 
> Document the wakeup-source property in the device description, which
> will indicate that the PHY has been wired up in such a way that it
> can wake the system from a low power state.
> 
> We will use this in a rewrite of the existing broken Wake-on-Lan code
> that was merged during the 6.16 merge window to support case 1. Case 2
> can be added to the driver later without needing to further alter the
> DT description. To be clear, the existing Wake-on-Lan code that was
> recently merged has multiple functional issues.
> 
> Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
> ---
> Apologies, this should've been sent with the patch to the driver which
> can be found at:
> 
> https://lore.kernel.org/r/E1um8Ld-008jxD-Mc@rmk-PC.armlinux.org.uk

Acked-by: Conor Dooley <conor.dooley@microchip.com>

> 
>  Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml b/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
> index d248a08a2136..2b5697bd7c5d 100644
> --- a/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
> +++ b/Documentation/devicetree/bindings/net/realtek,rtl82xx.yaml
> @@ -45,12 +45,16 @@ title: Realtek RTL82xx PHY
>      description:
>        Disable CLKOUT clock, CLKOUT clock default is enabled after hardware reset.
>  
> -
>    realtek,aldps-enable:
>      type: boolean
>      description:
>        Enable ALDPS mode, ALDPS mode default is disabled after hardware reset.
>  
> +  wakeup-source:
> +    type: boolean
> +    description:
> +      Enable Wake-on-LAN support for the RTL8211F PHY.
> +
>  unevaluatedProperties: false
>  
>  allOf:
> -- 
> 2.30.2
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net-next] dt-bindings: net: realtek,rtl82xx: document wakeup-source property

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 13 Aug 2025 12:21:19 +0100 you wrote:
> The RTL8211F PHY has two modes for a single INTB/PMEB pin:
> 
> 1. INTB mode, where it signals interrupts to the CPU, which can
>    include wake-on-LAN events.
> 2. PMEB mode, where it only signals a wake-on-LAN event, which
>    may either be a latched logic low until software manually
>    clears the WoL state, or pulsed mode.
> 
> [...]

Here is the summary with links:
  - [net-next] dt-bindings: net: realtek,rtl82xx: document wakeup-source property
    https://git.kernel.org/netdev/net-next/c/a510980e740c

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html