xref: /linux/Documentation/ABI/testing/sysfs-class-led-trigger-netdev (revision 7d1f84f1b94e79cb95d974ab3ec54cb3a4d64f5b)
1What:		/sys/class/leds/<led>/device_name
2Date:		Dec 2017
3KernelVersion:	4.16
4Contact:	linux-leds@vger.kernel.org
5Description:
6		Specifies the network device name to monitor.
7
8What:		/sys/class/leds/<led>/interval
9Date:		Dec 2017
10KernelVersion:	4.16
11Contact:	linux-leds@vger.kernel.org
12Description:
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
21What:		/sys/class/leds/<led>/link
22Date:		Dec 2017
23KernelVersion:	4.16
24Contact:	linux-leds@vger.kernel.org
25Description:
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
35What:		/sys/class/leds/<led>/tx
36Date:		Dec 2017
37KernelVersion:	4.16
38Contact:	linux-leds@vger.kernel.org
39Description:
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
50What:		/sys/class/leds/<led>/rx
51Date:		Dec 2017
52KernelVersion:	4.16
53Contact:	linux-leds@vger.kernel.org
54Description:
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
65What:		/sys/class/leds/<led>/offloaded
66Date:		Jun 2023
67KernelVersion:	6.5
68Contact:	linux-leds@vger.kernel.org
69Description:
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		LED trigger core also provides a generic attribute for this
79		purpose, see `/sys/class/leds/<led>/trigger_may_offload_to_hw`.
80
81What:		/sys/class/leds/<led>/link_10
82Date:		Jun 2023
83KernelVersion:	6.5
84Contact:	linux-leds@vger.kernel.org
85Description:
86		Signal the link speed state of 10Mbps of the named network device.
87
88		If set to 0 (default), the LED's normal state is off.
89
90		If set to 1, the LED's normal state reflects the link state
91		speed of 10MBps of the named network device.
92		Setting this value also immediately changes the LED state.
93
94		Present only if the named network device supports 10Mbps link speed.
95
96What:		/sys/class/leds/<led>/link_100
97Date:		Jun 2023
98KernelVersion:	6.5
99Contact:	linux-leds@vger.kernel.org
100Description:
101		Signal the link speed state of 100Mbps of the named network device.
102
103		If set to 0 (default), the LED's normal state is off.
104
105		If set to 1, the LED's normal state reflects the link state
106		speed of 100Mbps of the named network device.
107		Setting this value also immediately changes the LED state.
108
109		Present only if the named network device supports 100Mbps link speed.
110
111What:		/sys/class/leds/<led>/link_1000
112Date:		Jun 2023
113KernelVersion:	6.5
114Contact:	linux-leds@vger.kernel.org
115Description:
116		Signal the link speed state of 1000Mbps of the named network device.
117
118		If set to 0 (default), the LED's normal state is off.
119
120		If set to 1, the LED's normal state reflects the link state
121		speed of 1000Mbps of the named network device.
122		Setting this value also immediately changes the LED state.
123
124		Present only if the named network device supports 1000Mbps link speed.
125
126What:		/sys/class/leds/<led>/link_2500
127Date:		Nov 2023
128KernelVersion:	6.8
129Contact:	linux-leds@vger.kernel.org
130Description:
131		Signal the link speed state of 2500Mbps of the named network device.
132
133		If set to 0 (default), the LED's normal state is off.
134
135		If set to 1, the LED's normal state reflects the link state
136		speed of 2500Mbps of the named network device.
137		Setting this value also immediately changes the LED state.
138
139		Present only if the named network device supports 2500Mbps link speed.
140
141What:		/sys/class/leds/<led>/link_5000
142Date:		Nov 2023
143KernelVersion:	6.8
144Contact:	linux-leds@vger.kernel.org
145Description:
146		Signal the link speed state of 5000Mbps of the named network device.
147
148		If set to 0 (default), the LED's normal state is off.
149
150		If set to 1, the LED's normal state reflects the link state
151		speed of 5000Mbps of the named network device.
152		Setting this value also immediately changes the LED state.
153
154		Present only if the named network device supports 5000Mbps link speed.
155
156What:		/sys/class/leds/<led>/link_10000
157Date:		Nov 2023
158KernelVersion:	6.8
159Contact:	linux-leds@vger.kernel.org
160Description:
161		Signal the link speed state of 10000Mbps of the named network device.
162
163		If set to 0 (default), the LED's normal state is off.
164
165		If set to 1, the LED's normal state reflects the link state
166		speed of 10000Mbps of the named network device.
167		Setting this value also immediately changes the LED state.
168
169		Present only if the named network device supports 10000Mbps link speed.
170
171What:		/sys/class/leds/<led>/half_duplex
172Date:		Jun 2023
173KernelVersion:	6.5
174Contact:	linux-leds@vger.kernel.org
175Description:
176		Signal the link half duplex state of the named network device.
177
178		If set to 0 (default), the LED's normal state is off.
179
180		If set to 1, the LED's normal state reflects the link half
181		duplex state of the named network device.
182		Setting this value also immediately changes the LED state.
183
184What:		/sys/class/leds/<led>/full_duplex
185Date:		Jun 2023
186KernelVersion:	6.5
187Contact:	linux-leds@vger.kernel.org
188Description:
189		Signal the link full duplex state of the named network device.
190
191		If set to 0 (default), the LED's normal state is off.
192
193		If set to 1, the LED's normal state reflects the link full
194		duplex state of the named network device.
195		Setting this value also immediately changes the LED state.
196