xref: /linux/Documentation/ABI/testing/sysfs-class-led-trigger-netdev (revision 71dfa617ea9f18e4585fe78364217cd32b1fc382)
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
78What:		/sys/class/leds/<led>/link_10
79Date:		Jun 2023
80KernelVersion:	6.5
81Contact:	linux-leds@vger.kernel.org
82Description:
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		Present only if the named network device supports 10Mbps link speed.
92
93What:		/sys/class/leds/<led>/link_100
94Date:		Jun 2023
95KernelVersion:	6.5
96Contact:	linux-leds@vger.kernel.org
97Description:
98		Signal the link speed state of 100Mbps of the named network device.
99
100		If set to 0 (default), the LED's normal state is off.
101
102		If set to 1, the LED's normal state reflects the link state
103		speed of 100Mbps of the named network device.
104		Setting this value also immediately changes the LED state.
105
106		Present only if the named network device supports 100Mbps link speed.
107
108What:		/sys/class/leds/<led>/link_1000
109Date:		Jun 2023
110KernelVersion:	6.5
111Contact:	linux-leds@vger.kernel.org
112Description:
113		Signal the link speed state of 1000Mbps of the named network device.
114
115		If set to 0 (default), the LED's normal state is off.
116
117		If set to 1, the LED's normal state reflects the link state
118		speed of 1000Mbps of the named network device.
119		Setting this value also immediately changes the LED state.
120
121		Present only if the named network device supports 1000Mbps link speed.
122
123What:		/sys/class/leds/<led>/link_2500
124Date:		Nov 2023
125KernelVersion:	6.8
126Contact:	linux-leds@vger.kernel.org
127Description:
128		Signal the link speed state of 2500Mbps of the named network device.
129
130		If set to 0 (default), the LED's normal state is off.
131
132		If set to 1, the LED's normal state reflects the link state
133		speed of 2500Mbps of the named network device.
134		Setting this value also immediately changes the LED state.
135
136		Present only if the named network device supports 2500Mbps link speed.
137
138What:		/sys/class/leds/<led>/link_5000
139Date:		Nov 2023
140KernelVersion:	6.8
141Contact:	linux-leds@vger.kernel.org
142Description:
143		Signal the link speed state of 5000Mbps of the named network device.
144
145		If set to 0 (default), the LED's normal state is off.
146
147		If set to 1, the LED's normal state reflects the link state
148		speed of 5000Mbps of the named network device.
149		Setting this value also immediately changes the LED state.
150
151		Present only if the named network device supports 5000Mbps link speed.
152
153What:		/sys/class/leds/<led>/link_10000
154Date:		Nov 2023
155KernelVersion:	6.8
156Contact:	linux-leds@vger.kernel.org
157Description:
158		Signal the link speed state of 10000Mbps of the named network device.
159
160		If set to 0 (default), the LED's normal state is off.
161
162		If set to 1, the LED's normal state reflects the link state
163		speed of 10000Mbps of the named network device.
164		Setting this value also immediately changes the LED state.
165
166		Present only if the named network device supports 10000Mbps link speed.
167
168What:		/sys/class/leds/<led>/half_duplex
169Date:		Jun 2023
170KernelVersion:	6.5
171Contact:	linux-leds@vger.kernel.org
172Description:
173		Signal the link half duplex state of the named network device.
174
175		If set to 0 (default), the LED's normal state is off.
176
177		If set to 1, the LED's normal state reflects the link half
178		duplex state of the named network device.
179		Setting this value also immediately changes the LED state.
180
181What:		/sys/class/leds/<led>/full_duplex
182Date:		Jun 2023
183KernelVersion:	6.5
184Contact:	linux-leds@vger.kernel.org
185Description:
186		Signal the link full duplex state of the named network device.
187
188		If set to 0 (default), the LED's normal state is off.
189
190		If set to 1, the LED's normal state reflects the link full
191		duplex state of the named network device.
192		Setting this value also immediately changes the LED state.
193