Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-class-led-trigger-netdev
1 What:           /sys/class/leds/<led>/device_name
2 Date:           Dec 2017
3 KernelVersion:  4.16
4 Contact:        linux-leds@vger.kernel.org
5 Description:
6                 Specifies the network device name to monitor.
7
8 What:           /sys/class/leds/<led>/interval
9 Date:           Dec 2017
10 KernelVersion:  4.16
11 Contact:        linux-leds@vger.kernel.org
12 Description:
13                 Specifies the duration of the LED blink in milliseconds.
14                 Defaults to 50 ms.
15
16                 When offloaded is true, the interval value MUST be set to the
17                 default value and cannot be changed.
18                 Trying to set any value in this specific mode will return
19                 an EINVAL error.
20
21 What:           /sys/class/leds/<led>/link
22 Date:           Dec 2017
23 KernelVersion:  4.16
24 Contact:        linux-leds@vger.kernel.org
25 Description:
26                 Signal the link state of the named network device.
27
28                 If set to 0 (default), the LED's normal state is off.
29
30                 If set to 1, the LED's normal state reflects the link state
31                 of the named network device.
32                 Setting this value also immediately changes the LED state.
33
34
35 What:           /sys/class/leds/<led>/tx
36 Date:           Dec 2017
37 KernelVersion:  4.16
38 Contact:        linux-leds@vger.kernel.org
39 Description:
40                 Signal transmission of data on the named network device.
41
42                 If set to 0 (default), the LED will not blink on transmission.
43
44                 If set to 1, the LED will blink for the milliseconds specified
45                 in interval to signal transmission.
46
47                 When offloaded is true, the blink interval is controlled by
48                 hardware and won't reflect the value set in interval.
49
50 What:           /sys/class/leds/<led>/rx
51 Date:           Dec 2017
52 KernelVersion:  4.16
53 Contact:        linux-leds@vger.kernel.org
54 Description:
55                 Signal reception of data on the named network device.
56
57                 If set to 0 (default), the LED will not blink on reception.
58
59                 If set to 1, the LED will blink for the milliseconds specified
60                 in interval to signal reception.
61
62                 When offloaded is true, the blink interval is controlled by
63                 hardware and won't reflect the value set in interval.
64
65 What:           /sys/class/leds/<led>/offloaded
66 Date:           Jun 2023
67 KernelVersion:  6.5
68 Contact:        linux-leds@vger.kernel.org
69 Description:
70                 Communicate whether the LED trigger modes are offloaded to
71                 hardware or whether software fallback is used.
72
73                 If 0, the LED is using software fallback to blink.
74
75                 If 1, the LED blinking in requested mode is offloaded to
76                 hardware.
77
78 What:           /sys/class/leds/<led>/link_10
79 Date:           Jun 2023
80 KernelVersion:  6.5
81 Contact:        linux-leds@vger.kernel.org
82 Description:
83                 Signal the link speed state of 10Mbps of the named network device.
84
85                 If set to 0 (default), the LED's normal state is off.
86
87                 If set to 1, the LED's normal state reflects the link state
88                 speed of 10MBps of the named network device.
89                 Setting this value also immediately changes the LED state.
90
91 What:           /sys/class/leds/<led>/link_100
92 Date:           Jun 2023
93 KernelVersion:  6.5
94 Contact:        linux-leds@vger.kernel.org
95 Description:
96                 Signal the link speed state of 100Mbps of the named network device.
97
98                 If set to 0 (default), the LED's normal state is off.
99
100                 If set to 1, the LED's normal state reflects the link state
101                 speed of 100Mbps of the named network device.
102                 Setting this value also immediately changes the LED state.
103
104 What:           /sys/class/leds/<led>/link_1000
105 Date:           Jun 2023
106 KernelVersion:  6.5
107 Contact:        linux-leds@vger.kernel.org
108 Description:
109                 Signal the link speed state of 1000Mbps of the named network device.
110
111                 If set to 0 (default), the LED's normal state is off.
112
113                 If set to 1, the LED's normal state reflects the link state
114                 speed of 1000Mbps of the named network device.
115                 Setting this value also immediately changes the LED state.
116
117 What:           /sys/class/leds/<led>/half_duplex
118 Date:           Jun 2023
119 KernelVersion:  6.5
120 Contact:        linux-leds@vger.kernel.org
121 Description:
122                 Signal the link half duplex state of the named network device.
123
124                 If set to 0 (default), the LED's normal state is off.
125
126                 If set to 1, the LED's normal state reflects the link half
127                 duplex state of the named network device.
128                 Setting this value also immediately changes the LED state.
129
130 What:           /sys/class/leds/<led>/full_duplex
131 Date:           Jun 2023
132 KernelVersion:  6.5
133 Contact:        linux-leds@vger.kernel.org
134 Description:
135                 Signal the link full duplex state of the named network device.
136
137                 If set to 0 (default), the LED's normal state is off.
138
139                 If set to 1, the LED's normal state reflects the link full
140                 duplex state of the named network device.
141                 Setting this value also immediately changes the LED state.