linux-imx/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
Marek Behún 44f0fb8dfe leds: trigger: netdev: rename 'hw_control' sysfs entry to 'offloaded'
Commit b655892ffd ("leds: trigger: netdev: expose hw_control status
via sysfs") exposed to sysfs the flag that tells whether the LED trigger
is offloaded to hardware, under the name "hw_control", since that is the
name under which this setting is called in the code.

Everywhere else in kernel when some work that is normally done in
software can be made to be done by hardware instead, we use the word
"offloading" to describe this, e.g. "LED blinking is offloaded to
hardware".

Normally renaming sysfs entries is a no-go because of backwards
compatibility. But since this patch was not yet released in a stable
kernel, I think it is still possible to rename it, if there is
consensus.

Fixes: b655892ffd ("leds: trigger: netdev: expose hw_control status via sysfs")
Signed-off-by: Marek Behún <kabel@kernel.org>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/20230821121453.30203-1-kabel@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2023-08-22 11:02:29 -07:00

4.2 KiB

What: /sys/class/leds//device_name Date: Dec 2017 KernelVersion: 4.16 Contact: linux-leds@vger.kernel.org Description: Specifies the network device name to monitor.

What: /sys/class/leds//interval Date: Dec 2017 KernelVersion: 4.16 Contact: linux-leds@vger.kernel.org Description: Specifies the duration of the LED blink in milliseconds. Defaults to 50 ms.

	When offloaded is true, 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//link Date: Dec 2017 KernelVersion: 4.16 Contact: linux-leds@vger.kernel.org Description: Signal the link 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 state
	of the named network device.
	Setting this value also immediately changes the LED state.

What: /sys/class/leds//tx Date: Dec 2017 KernelVersion: 4.16 Contact: linux-leds@vger.kernel.org Description: Signal transmission of data on the named network device.

	If set to 0 (default), the LED will not blink on transmission.

	If set to 1, the LED will blink for the milliseconds specified
	in interval to signal transmission.

	When offloaded is true, the blink interval is controlled by
	hardware and won't reflect the value set in interval.

What: /sys/class/leds//rx Date: Dec 2017 KernelVersion: 4.16 Contact: linux-leds@vger.kernel.org Description: Signal reception of data on the named network device.

	If set to 0 (default), the LED will not blink on reception.

	If set to 1, the LED will blink for the milliseconds specified
	in interval to signal reception.

	When offloaded is true, the blink interval is controlled by
	hardware and won't reflect the value set in interval.

What: /sys/class/leds//offloaded Date: Jun 2023 KernelVersion: 6.5 Contact: linux-leds@vger.kernel.org Description: Communicate whether the LED trigger modes are offloaded to hardware or whether software fallback is used.

	If 0, the LED is using software fallback to blink.

	If 1, the LED blinking in requested mode is offloaded to
	hardware.

What: /sys/class/leds//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//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//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//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//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.