docs: ABI: sysfs-class-led-trigger-netdev: add new modes and entry
authorChristian Marangi <ansuelsmth@gmail.com>
Wed, 21 Jun 2023 09:26:53 +0000 (11:26 +0200)
committerJakub Kicinski <kuba@kernel.org>
Fri, 23 Jun 2023 02:51:02 +0000 (19:51 -0700)
Document newly introduced modes and entry for the LED netdev trigger.

Add documentation for new modes:
- link_10
- link_100
- link_1000
- half_duplex
- full_duplex

Add documentation for new entry:
- hw_control

Also add additional info for the interval entry and the tx/rx modes with
the special case of hw_control ON.

Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/20230621092653.23172-1-ansuelsmth@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/ABI/testing/sysfs-class-led-trigger-netdev

index 6465409..78b62a2 100644 (file)
@@ -13,6 +13,11 @@ Description:
                Specifies the duration of the LED blink in milliseconds.
                Defaults to 50 ms.
 
+               With hw_control ON, the interval value MUST be set to the
+               default value and cannot be changed.
+               Trying to set any value in this specific mode will return
+               an EINVAL error.
+
 What:          /sys/class/leds/<led>/link
 Date:          Dec 2017
 KernelVersion: 4.16
@@ -39,6 +44,9 @@ Description:
                If set to 1, the LED will blink for the milliseconds specified
                in interval to signal transmission.
 
+               With hw_control ON, the blink interval is controlled by hardware
+               and won't reflect the value set in interval.
+
 What:          /sys/class/leds/<led>/rx
 Date:          Dec 2017
 KernelVersion: 4.16
@@ -50,3 +58,84 @@ Description:
 
                If set to 1, the LED will blink for the milliseconds specified
                in interval to signal reception.
+
+               With hw_control ON, the blink interval is controlled by hardware
+               and won't reflect the value set in interval.
+
+What:          /sys/class/leds/<led>/hw_control
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Communicate whether the LED trigger modes are driven by hardware
+               or software fallback is used.
+
+               If 0, the LED is using software fallback to blink.
+
+               If 1, the LED is using hardware control to blink and signal the
+               requested modes.
+
+What:          /sys/class/leds/<led>/link_10
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Signal the link speed state of 10Mbps 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 10MBps of the named network device.
+               Setting this value also immediately changes the LED state.
+
+What:          /sys/class/leds/<led>/link_100
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Signal the link speed state of 100Mbps 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 100Mbps of the named network device.
+               Setting this value also immediately changes the LED state.
+
+What:          /sys/class/leds/<led>/link_1000
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Signal the link speed state of 1000Mbps 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 1000Mbps 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
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Signal the link half duplex state 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 half
+               duplex state of the named network device.
+               Setting this value also immediately changes the LED state.
+
+What:          /sys/class/leds/<led>/full_duplex
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Signal the link full duplex state 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 full
+               duplex state of the named network device.
+               Setting this value also immediately changes the LED state.