[v3,2/2] docs: ABI: sysfs-class-led-trigger-netdev: add new modes and entry

Message ID e72a6794639cf3881d698e1d34b456e747da1b95.1701143925.git.daniel@makrotopia.org
State New
Headers
Series [v3,1/2] leds: trigger: netdev: extend speeds up to 10G |

Commit Message

Daniel Golle Nov. 28, 2023, 4 a.m. UTC
  Document newly introduced modes for the LED netdev trigger.

Add documentation for new modes:
- link_2500
- link_5000
- link_10000

Signed-off-by: Daniel Golle <daniel@makrotopia.org>
---
v3: include this documentation patch as well

 .../testing/sysfs-class-led-trigger-netdev    | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
  

Comments

Marek BehĂșn Dec. 7, 2023, 4:30 p.m. UTC | #1
On Tue, 28 Nov 2023 04:00:39 +0000
Daniel Golle <daniel@makrotopia.org> wrote:

> Document newly introduced modes for the LED netdev trigger.
> 
> Add documentation for new modes:
> - link_2500
> - link_5000
> - link_10000
> 
> Signed-off-by: Daniel Golle <daniel@makrotopia.org>
> ---
> v3: include this documentation patch as well
> 
>  .../testing/sysfs-class-led-trigger-netdev    | 39 +++++++++++++++++++
>  1 file changed, 39 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-led-trigger-netdev b/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
> index f6d9d72ce77b7..a6c307c4befa0 100644
> --- a/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
> +++ b/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
> @@ -114,6 +114,45 @@ Description:
>  		speed of 1000Mbps of the named network device.
>  		Setting this value also immediately changes the LED state.
>  
> +What:		/sys/class/leds/<led>/link_2500
> +Date:		Nov 2023
> +KernelVersion:	6.8
> +Contact:	linux-leds@vger.kernel.org
> +Description:
> +		Signal the link speed state of 2500Mbps of the named network device.

Should this file be present even if the network device does not support
that speed?

Marek
  

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-led-trigger-netdev b/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
index f6d9d72ce77b7..a6c307c4befa0 100644
--- a/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
+++ b/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
@@ -114,6 +114,45 @@  Description:
 		speed of 1000Mbps of the named network device.
 		Setting this value also immediately changes the LED state.
 
+What:		/sys/class/leds/<led>/link_2500
+Date:		Nov 2023
+KernelVersion:	6.8
+Contact:	linux-leds@vger.kernel.org
+Description:
+		Signal the link speed state of 2500Mbps of the named network device.
+
+		If set to 0 (default), the LED's normal state is off.
+
+		If set to 1, the LED's normal state reflects the link state
+		speed of 2500Mbps of the named network device.
+		Setting this value also immediately changes the LED state.
+
+What:		/sys/class/leds/<led>/link_5000
+Date:		Nov 2023
+KernelVersion:	6.8
+Contact:	linux-leds@vger.kernel.org
+Description:
+		Signal the link speed state of 5000Mbps of the named network device.
+
+		If set to 0 (default), the LED's normal state is off.
+
+		If set to 1, the LED's normal state reflects the link state
+		speed of 5000Mbps of the named network device.
+		Setting this value also immediately changes the LED state.
+
+What:		/sys/class/leds/<led>/link_10000
+Date:		Nov 2023
+KernelVersion:	6.8
+Contact:	linux-leds@vger.kernel.org
+Description:
+		Signal the link speed state of 10000Mbps of the named network device.
+
+		If set to 0 (default), the LED's normal state is off.
+
+		If set to 1, the LED's normal state reflects the link state
+		speed of 10000Mbps of the named network device.
+		Setting this value also immediately changes the LED state.
+
 What:		/sys/class/leds/<led>/half_duplex
 Date:		Jun 2023
 KernelVersion:	6.5