xref: /linux/drivers/leds/trigger/ledtrig-netdev.c (revision 6443f4f20bdae726fe01cf5946fba9742a0ffda6)
1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright 2017 Ben Whitten <ben.whitten@gmail.com>
3 // Copyright 2007 Oliver Jowett <oliver@opencloud.com>
4 //
5 // LED Kernel Netdev Trigger
6 //
7 // Toggles the LED to reflect the link and traffic state of a named net device
8 //
9 // Derived from ledtrig-timer.c which is:
10 //  Copyright 2005-2006 Openedhand Ltd.
11 //  Author: Richard Purdie <rpurdie@openedhand.com>
12 
13 #include <linux/atomic.h>
14 #include <linux/ctype.h>
15 #include <linux/device.h>
16 #include <linux/ethtool.h>
17 #include <linux/init.h>
18 #include <linux/jiffies.h>
19 #include <linux/kernel.h>
20 #include <linux/leds.h>
21 #include <linux/linkmode.h>
22 #include <linux/list.h>
23 #include <linux/module.h>
24 #include <linux/netdevice.h>
25 #include <linux/mutex.h>
26 #include <linux/phy.h>
27 #include <linux/rtnetlink.h>
28 #include <linux/timer.h>
29 #include <net/netdev_lock.h>
30 #include "../leds.h"
31 
32 #define NETDEV_LED_DEFAULT_INTERVAL	50
33 
34 /*
35  * Configurable sysfs attributes:
36  *
37  * device_name - network device name to monitor
38  * interval - duration of LED blink, in milliseconds
39  * link -  LED's normal state reflects whether the link is up
40  *         (has carrier) or not
41  * tx -  LED blinks on transmitted data
42  * rx -  LED blinks on receive data
43  * tx_err -  LED blinks on transmit error
44  * rx_err -  LED blinks on receive error
45  *
46  * Note: If the user selects a mode that is not supported by hw, default
47  * behavior is to fall back to software control of the LED. However not every
48  * hw supports software control. LED callbacks brightness_set() and
49  * brightness_set_blocking() are NULL in this case. hw_control_is_supported()
50  * should use available means supported by hw to inform the user that selected
51  * mode isn't supported by hw. This could be switching off the LED or any
52  * hw blink mode. If software control fallback isn't possible, we return
53  * -EOPNOTSUPP to the user, but still store the selected mode. This is needed
54  * in case an intermediate unsupported mode is necessary to switch from one
55  * supported mode to another.
56  */
57 
58 struct led_netdev_data {
59 	struct mutex lock;
60 
61 	struct delayed_work work;
62 	struct notifier_block notifier;
63 
64 	struct led_classdev *led_cdev;
65 	struct net_device *net_dev;
66 
67 	char device_name[IFNAMSIZ];
68 	atomic_t interval;
69 	unsigned int last_activity;
70 
71 	unsigned long mode;
72 	int link_speed;
73 	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported_link_modes);
74 	u8 duplex;
75 
76 	bool carrier_link_up;
77 	bool hw_control;
78 };
79 
80 static const struct attribute_group netdev_trig_link_speed_attrs_group;
81 
82 static void set_baseline_state(struct led_netdev_data *trigger_data)
83 {
84 	int current_brightness;
85 	struct led_classdev *led_cdev = trigger_data->led_cdev;
86 
87 	/* Already validated, hw control is possible with the requested mode */
88 	if (trigger_data->hw_control) {
89 		led_cdev->hw_control_set(led_cdev, trigger_data->mode);
90 
91 		return;
92 	}
93 
94 	current_brightness = led_cdev->brightness;
95 	if (current_brightness)
96 		led_cdev->blink_brightness = current_brightness;
97 	if (!led_cdev->blink_brightness)
98 		led_cdev->blink_brightness = led_cdev->max_brightness;
99 
100 	if (!trigger_data->carrier_link_up) {
101 		led_set_brightness(led_cdev, LED_OFF);
102 	} else {
103 		bool blink_on = false;
104 
105 		if (test_bit(TRIGGER_NETDEV_LINK, &trigger_data->mode))
106 			blink_on = true;
107 
108 		if (test_bit(TRIGGER_NETDEV_LINK_10, &trigger_data->mode) &&
109 		    trigger_data->link_speed == SPEED_10)
110 			blink_on = true;
111 
112 		if (test_bit(TRIGGER_NETDEV_LINK_100, &trigger_data->mode) &&
113 		    trigger_data->link_speed == SPEED_100)
114 			blink_on = true;
115 
116 		if (test_bit(TRIGGER_NETDEV_LINK_1000, &trigger_data->mode) &&
117 		    trigger_data->link_speed == SPEED_1000)
118 			blink_on = true;
119 
120 		if (test_bit(TRIGGER_NETDEV_LINK_2500, &trigger_data->mode) &&
121 		    trigger_data->link_speed == SPEED_2500)
122 			blink_on = true;
123 
124 		if (test_bit(TRIGGER_NETDEV_LINK_5000, &trigger_data->mode) &&
125 		    trigger_data->link_speed == SPEED_5000)
126 			blink_on = true;
127 
128 		if (test_bit(TRIGGER_NETDEV_LINK_10000, &trigger_data->mode) &&
129 		    trigger_data->link_speed == SPEED_10000)
130 			blink_on = true;
131 
132 		if (test_bit(TRIGGER_NETDEV_HALF_DUPLEX, &trigger_data->mode) &&
133 		    trigger_data->duplex == DUPLEX_HALF)
134 			blink_on = true;
135 
136 		if (test_bit(TRIGGER_NETDEV_FULL_DUPLEX, &trigger_data->mode) &&
137 		    trigger_data->duplex == DUPLEX_FULL)
138 			blink_on = true;
139 
140 		if (blink_on)
141 			led_set_brightness(led_cdev,
142 					   led_cdev->blink_brightness);
143 		else
144 			led_set_brightness(led_cdev, LED_OFF);
145 
146 		/* If we are looking for RX/TX start periodically
147 		 * checking stats
148 		 */
149 		if (test_bit(TRIGGER_NETDEV_TX, &trigger_data->mode) ||
150 		    test_bit(TRIGGER_NETDEV_RX, &trigger_data->mode) ||
151 		    test_bit(TRIGGER_NETDEV_TX_ERR, &trigger_data->mode) ||
152 		    test_bit(TRIGGER_NETDEV_RX_ERR, &trigger_data->mode))
153 			schedule_delayed_work(&trigger_data->work, 0);
154 	}
155 }
156 
157 static bool supports_hw_control(struct led_classdev *led_cdev)
158 {
159 	if (!led_cdev->hw_control_get || !led_cdev->hw_control_set ||
160 	    !led_cdev->hw_control_is_supported)
161 		return false;
162 
163 	return !strcmp(led_cdev->hw_control_trigger, led_cdev->trigger->name);
164 }
165 
166 /*
167  * Validate the configured netdev is the same as the one associated with
168  * the LED driver in hw control.
169  */
170 static bool validate_net_dev(struct led_classdev *led_cdev,
171 			     struct net_device *net_dev)
172 {
173 	struct device *dev = led_cdev->hw_control_get_device(led_cdev);
174 	struct net_device *ndev;
175 
176 	if (!dev)
177 		return false;
178 
179 	ndev = to_net_dev(dev);
180 
181 	return ndev == net_dev;
182 }
183 
184 static bool can_hw_control(struct led_netdev_data *trigger_data)
185 {
186 	unsigned long default_interval = msecs_to_jiffies(NETDEV_LED_DEFAULT_INTERVAL);
187 	unsigned int interval = atomic_read(&trigger_data->interval);
188 	struct led_classdev *led_cdev = trigger_data->led_cdev;
189 	int ret;
190 
191 	if (!supports_hw_control(led_cdev))
192 		return false;
193 
194 	/*
195 	 * Interval must be set to the default
196 	 * value. Any different value is rejected if in hw
197 	 * control.
198 	 */
199 	if (interval != default_interval)
200 		return false;
201 
202 	/*
203 	 * net_dev must be set with hw control, otherwise no
204 	 * blinking can be happening and there is nothing to
205 	 * offloaded. Additionally, for hw control to be
206 	 * valid, the configured netdev must be the same as
207 	 * netdev associated to the LED.
208 	 */
209 	if (!validate_net_dev(led_cdev, trigger_data->net_dev))
210 		return false;
211 
212 	/* Check if the requested mode is supported */
213 	ret = led_cdev->hw_control_is_supported(led_cdev, trigger_data->mode);
214 	/* Fall back to software blinking if not supported */
215 	if (ret == -EOPNOTSUPP)
216 		return false;
217 	if (ret) {
218 		dev_warn(led_cdev->dev,
219 			 "Current mode check failed with error %d\n", ret);
220 		return false;
221 	}
222 
223 	return true;
224 }
225 
226 static void get_device_state(struct led_netdev_data *trigger_data)
227 {
228 	struct ethtool_link_ksettings cmd;
229 
230 	trigger_data->carrier_link_up = netif_carrier_ok(trigger_data->net_dev);
231 
232 	if (netif_get_link_ksettings(trigger_data->net_dev, &cmd))
233 		return;
234 
235 	if (trigger_data->carrier_link_up) {
236 		trigger_data->link_speed = cmd.base.speed;
237 		trigger_data->duplex = cmd.base.duplex;
238 	}
239 
240 	/*
241 	 * Have a local copy of the link speed supported to avoid rtnl lock every time
242 	 * modes are refreshed on any change event
243 	 */
244 	linkmode_copy(trigger_data->supported_link_modes, cmd.link_modes.supported);
245 }
246 
247 static ssize_t device_name_show(struct device *dev,
248 				struct device_attribute *attr, char *buf)
249 {
250 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
251 	ssize_t len;
252 
253 	mutex_lock(&trigger_data->lock);
254 	len = sprintf(buf, "%s\n", trigger_data->device_name);
255 	mutex_unlock(&trigger_data->lock);
256 
257 	return len;
258 }
259 
260 static int set_device_name(struct led_netdev_data *trigger_data,
261 			   const char *name, size_t size)
262 {
263 	struct net_device *new_dev = NULL;
264 	char device_name[IFNAMSIZ];
265 
266 	if (size >= IFNAMSIZ)
267 		return -EINVAL;
268 
269 	cancel_delayed_work_sync(&trigger_data->work);
270 
271 	memcpy(device_name, name, size);
272 	device_name[size] = 0;
273 	if (size > 0 && device_name[size - 1] == '\n')
274 		device_name[size - 1] = 0;
275 
276 	/*
277 	 * Lock order: rtnl_lock -> netdev instance lock -> trigger_data lock.
278 	 */
279 	rtnl_lock();
280 	if (device_name[0]) {
281 		new_dev = dev_get_by_name(&init_net, device_name);
282 		if (new_dev)
283 			netdev_lock_ops(new_dev);
284 	}
285 	mutex_lock(&trigger_data->lock);
286 
287 	dev_put(trigger_data->net_dev);
288 	trigger_data->net_dev = new_dev;
289 	strscpy(trigger_data->device_name, device_name);
290 
291 	trigger_data->carrier_link_up = false;
292 	trigger_data->link_speed = SPEED_UNKNOWN;
293 	trigger_data->duplex = DUPLEX_UNKNOWN;
294 	if (trigger_data->net_dev)
295 		get_device_state(trigger_data);
296 
297 	trigger_data->last_activity = 0;
298 
299 	/* Skip if we're called from netdev_trig_activate() and hw_control is true */
300 	if (!trigger_data->hw_control || led_get_trigger_data(trigger_data->led_cdev))
301 		set_baseline_state(trigger_data);
302 
303 	mutex_unlock(&trigger_data->lock);
304 	if (new_dev)
305 		netdev_unlock_ops(new_dev);
306 	rtnl_unlock();
307 
308 	return 0;
309 }
310 
311 static ssize_t device_name_store(struct device *dev,
312 				 struct device_attribute *attr, const char *buf,
313 				 size_t size)
314 {
315 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
316 	int ret;
317 
318 	ret = set_device_name(trigger_data, buf, size);
319 
320 	if (ret < 0)
321 		return ret;
322 
323 	/* Refresh link_speed visibility */
324 	sysfs_update_group(&dev->kobj, &netdev_trig_link_speed_attrs_group);
325 
326 	return size;
327 }
328 
329 static DEVICE_ATTR_RW(device_name);
330 
331 static ssize_t netdev_led_attr_show(struct device *dev, char *buf,
332 				    enum led_trigger_netdev_modes attr)
333 {
334 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
335 	int bit;
336 
337 	switch (attr) {
338 	case TRIGGER_NETDEV_LINK:
339 	case TRIGGER_NETDEV_LINK_10:
340 	case TRIGGER_NETDEV_LINK_100:
341 	case TRIGGER_NETDEV_LINK_1000:
342 	case TRIGGER_NETDEV_LINK_2500:
343 	case TRIGGER_NETDEV_LINK_5000:
344 	case TRIGGER_NETDEV_LINK_10000:
345 	case TRIGGER_NETDEV_HALF_DUPLEX:
346 	case TRIGGER_NETDEV_FULL_DUPLEX:
347 	case TRIGGER_NETDEV_TX:
348 	case TRIGGER_NETDEV_RX:
349 	case TRIGGER_NETDEV_TX_ERR:
350 	case TRIGGER_NETDEV_RX_ERR:
351 		bit = attr;
352 		break;
353 	default:
354 		return -EINVAL;
355 	}
356 
357 	return sprintf(buf, "%u\n", test_bit(bit, &trigger_data->mode));
358 }
359 
360 static ssize_t netdev_led_attr_store(struct device *dev, const char *buf,
361 				     size_t size, enum led_trigger_netdev_modes attr)
362 {
363 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
364 	struct led_classdev *led_cdev = trigger_data->led_cdev;
365 	unsigned long state, mode = trigger_data->mode;
366 	int ret;
367 	int bit;
368 
369 	ret = kstrtoul(buf, 0, &state);
370 	if (ret)
371 		return ret;
372 
373 	switch (attr) {
374 	case TRIGGER_NETDEV_LINK:
375 	case TRIGGER_NETDEV_LINK_10:
376 	case TRIGGER_NETDEV_LINK_100:
377 	case TRIGGER_NETDEV_LINK_1000:
378 	case TRIGGER_NETDEV_LINK_2500:
379 	case TRIGGER_NETDEV_LINK_5000:
380 	case TRIGGER_NETDEV_LINK_10000:
381 	case TRIGGER_NETDEV_HALF_DUPLEX:
382 	case TRIGGER_NETDEV_FULL_DUPLEX:
383 	case TRIGGER_NETDEV_TX:
384 	case TRIGGER_NETDEV_RX:
385 	case TRIGGER_NETDEV_TX_ERR:
386 	case TRIGGER_NETDEV_RX_ERR:
387 		bit = attr;
388 		break;
389 	default:
390 		return -EINVAL;
391 	}
392 
393 	if (state)
394 		set_bit(bit, &mode);
395 	else
396 		clear_bit(bit, &mode);
397 
398 	if (test_bit(TRIGGER_NETDEV_LINK, &mode) &&
399 	    (test_bit(TRIGGER_NETDEV_LINK_10, &mode) ||
400 	     test_bit(TRIGGER_NETDEV_LINK_100, &mode) ||
401 	     test_bit(TRIGGER_NETDEV_LINK_1000, &mode) ||
402 	     test_bit(TRIGGER_NETDEV_LINK_2500, &mode) ||
403 	     test_bit(TRIGGER_NETDEV_LINK_5000, &mode) ||
404 	     test_bit(TRIGGER_NETDEV_LINK_10000, &mode)))
405 		return -EINVAL;
406 
407 	cancel_delayed_work_sync(&trigger_data->work);
408 
409 	trigger_data->mode = mode;
410 	trigger_data->hw_control = can_hw_control(trigger_data);
411 
412 	if (!led_cdev->brightness_set && !led_cdev->brightness_set_blocking &&
413 	    !trigger_data->hw_control)
414 		return -EOPNOTSUPP;
415 
416 	set_baseline_state(trigger_data);
417 
418 	return size;
419 }
420 
421 #define DEFINE_NETDEV_TRIGGER(trigger_name, trigger) \
422 	static ssize_t trigger_name##_show(struct device *dev, \
423 		struct device_attribute *attr, char *buf) \
424 	{ \
425 		return netdev_led_attr_show(dev, buf, trigger); \
426 	} \
427 	static ssize_t trigger_name##_store(struct device *dev, \
428 		struct device_attribute *attr, const char *buf, size_t size) \
429 	{ \
430 		return netdev_led_attr_store(dev, buf, size, trigger); \
431 	} \
432 	static DEVICE_ATTR_RW(trigger_name)
433 
434 DEFINE_NETDEV_TRIGGER(link, TRIGGER_NETDEV_LINK);
435 DEFINE_NETDEV_TRIGGER(link_10, TRIGGER_NETDEV_LINK_10);
436 DEFINE_NETDEV_TRIGGER(link_100, TRIGGER_NETDEV_LINK_100);
437 DEFINE_NETDEV_TRIGGER(link_1000, TRIGGER_NETDEV_LINK_1000);
438 DEFINE_NETDEV_TRIGGER(link_2500, TRIGGER_NETDEV_LINK_2500);
439 DEFINE_NETDEV_TRIGGER(link_5000, TRIGGER_NETDEV_LINK_5000);
440 DEFINE_NETDEV_TRIGGER(link_10000, TRIGGER_NETDEV_LINK_10000);
441 DEFINE_NETDEV_TRIGGER(half_duplex, TRIGGER_NETDEV_HALF_DUPLEX);
442 DEFINE_NETDEV_TRIGGER(full_duplex, TRIGGER_NETDEV_FULL_DUPLEX);
443 DEFINE_NETDEV_TRIGGER(tx, TRIGGER_NETDEV_TX);
444 DEFINE_NETDEV_TRIGGER(rx, TRIGGER_NETDEV_RX);
445 DEFINE_NETDEV_TRIGGER(tx_err, TRIGGER_NETDEV_TX_ERR);
446 DEFINE_NETDEV_TRIGGER(rx_err, TRIGGER_NETDEV_RX_ERR);
447 
448 static ssize_t interval_show(struct device *dev,
449 			     struct device_attribute *attr, char *buf)
450 {
451 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
452 
453 	return sprintf(buf, "%u\n",
454 		       jiffies_to_msecs(atomic_read(&trigger_data->interval)));
455 }
456 
457 static ssize_t interval_store(struct device *dev,
458 			      struct device_attribute *attr, const char *buf,
459 			      size_t size)
460 {
461 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
462 	unsigned long value;
463 	int ret;
464 
465 	if (trigger_data->hw_control)
466 		return -EINVAL;
467 
468 	ret = kstrtoul(buf, 0, &value);
469 	if (ret)
470 		return ret;
471 
472 	/* impose some basic bounds on the timer interval */
473 	if (value >= 5 && value <= 10000) {
474 		cancel_delayed_work_sync(&trigger_data->work);
475 
476 		atomic_set(&trigger_data->interval, msecs_to_jiffies(value));
477 		set_baseline_state(trigger_data);	/* resets timer */
478 	}
479 
480 	return size;
481 }
482 
483 static DEVICE_ATTR_RW(interval);
484 
485 static ssize_t offloaded_show(struct device *dev,
486 			      struct device_attribute *attr, char *buf)
487 {
488 	struct led_netdev_data *trigger_data = led_trigger_get_drvdata(dev);
489 
490 	return sprintf(buf, "%d\n", trigger_data->hw_control);
491 }
492 
493 static DEVICE_ATTR_RO(offloaded);
494 
495 #define CHECK_LINK_MODE_ATTR(link_speed) \
496 	do { \
497 		if (attr == &dev_attr_link_##link_speed.attr && \
498 		    link_ksettings.base.speed == SPEED_##link_speed) \
499 			return attr->mode; \
500 	} while (0)
501 
502 static umode_t netdev_trig_link_speed_visible(struct kobject *kobj,
503 					      struct attribute *attr, int n)
504 {
505 	struct device *dev = kobj_to_dev(kobj);
506 	struct led_netdev_data *trigger_data;
507 	unsigned long *supported_link_modes;
508 	u32 mode;
509 
510 	trigger_data = led_trigger_get_drvdata(dev);
511 	supported_link_modes = trigger_data->supported_link_modes;
512 
513 	/*
514 	 * Search in the supported link mode mask a matching supported mode.
515 	 * Stop at the first matching entry as we care only to check if a particular
516 	 * speed is supported and not the kind.
517 	 */
518 	for_each_set_bit(mode, supported_link_modes, __ETHTOOL_LINK_MODE_MASK_NBITS) {
519 		struct ethtool_link_ksettings link_ksettings;
520 
521 		ethtool_params_from_link_mode(&link_ksettings, mode);
522 
523 		CHECK_LINK_MODE_ATTR(10);
524 		CHECK_LINK_MODE_ATTR(100);
525 		CHECK_LINK_MODE_ATTR(1000);
526 		CHECK_LINK_MODE_ATTR(2500);
527 		CHECK_LINK_MODE_ATTR(5000);
528 		CHECK_LINK_MODE_ATTR(10000);
529 	}
530 
531 	return 0;
532 }
533 
534 static struct attribute *netdev_trig_link_speed_attrs[] = {
535 	&dev_attr_link_10.attr,
536 	&dev_attr_link_100.attr,
537 	&dev_attr_link_1000.attr,
538 	&dev_attr_link_2500.attr,
539 	&dev_attr_link_5000.attr,
540 	&dev_attr_link_10000.attr,
541 	NULL
542 };
543 
544 static const struct attribute_group netdev_trig_link_speed_attrs_group = {
545 	.attrs = netdev_trig_link_speed_attrs,
546 	.is_visible = netdev_trig_link_speed_visible,
547 };
548 
549 static struct attribute *netdev_trig_attrs[] = {
550 	&dev_attr_device_name.attr,
551 	&dev_attr_link.attr,
552 	&dev_attr_full_duplex.attr,
553 	&dev_attr_half_duplex.attr,
554 	&dev_attr_rx.attr,
555 	&dev_attr_tx.attr,
556 	&dev_attr_rx_err.attr,
557 	&dev_attr_tx_err.attr,
558 	&dev_attr_interval.attr,
559 	&dev_attr_offloaded.attr,
560 	NULL
561 };
562 
563 static const struct attribute_group netdev_trig_attrs_group = {
564 	.attrs = netdev_trig_attrs,
565 };
566 
567 static const struct attribute_group *netdev_trig_groups[] = {
568 	&netdev_trig_attrs_group,
569 	&netdev_trig_link_speed_attrs_group,
570 	NULL,
571 };
572 
573 static int netdev_trig_notify(struct notifier_block *nb,
574 			      unsigned long evt, void *dv)
575 {
576 	struct net_device *dev =
577 		netdev_notifier_info_to_dev((struct netdev_notifier_info *)dv);
578 	struct led_netdev_data *trigger_data =
579 		container_of(nb, struct led_netdev_data, notifier);
580 	struct led_classdev *led_cdev = trigger_data->led_cdev;
581 
582 	if (evt != NETDEV_UP && evt != NETDEV_DOWN && evt != NETDEV_CHANGE
583 	    && evt != NETDEV_REGISTER && evt != NETDEV_UNREGISTER
584 	    && evt != NETDEV_CHANGENAME)
585 		return NOTIFY_DONE;
586 
587 	if (!(dev == trigger_data->net_dev ||
588 	      (evt == NETDEV_CHANGENAME && !strcmp(dev->name, trigger_data->device_name)) ||
589 	      (evt == NETDEV_REGISTER && !strcmp(dev->name, trigger_data->device_name))))
590 		return NOTIFY_DONE;
591 
592 	cancel_delayed_work_sync(&trigger_data->work);
593 
594 	mutex_lock(&trigger_data->lock);
595 
596 	trigger_data->carrier_link_up = false;
597 	trigger_data->link_speed = SPEED_UNKNOWN;
598 	trigger_data->duplex = DUPLEX_UNKNOWN;
599 	switch (evt) {
600 	case NETDEV_CHANGENAME:
601 	case NETDEV_REGISTER:
602 		dev_put(trigger_data->net_dev);
603 		dev_hold(dev);
604 		trigger_data->net_dev = dev;
605 		if (evt == NETDEV_CHANGENAME)
606 			get_device_state(trigger_data);
607 		break;
608 	case NETDEV_UNREGISTER:
609 		dev_put(trigger_data->net_dev);
610 		trigger_data->net_dev = NULL;
611 		break;
612 	case NETDEV_UP:
613 		trigger_data->hw_control = can_hw_control(trigger_data);
614 		fallthrough;
615 	case NETDEV_CHANGE:
616 		get_device_state(trigger_data);
617 		/* Refresh link_speed visibility */
618 		if (evt == NETDEV_CHANGE)
619 			sysfs_update_group(&led_cdev->dev->kobj,
620 					   &netdev_trig_link_speed_attrs_group);
621 		break;
622 	}
623 
624 	set_baseline_state(trigger_data);
625 
626 	mutex_unlock(&trigger_data->lock);
627 
628 	return NOTIFY_DONE;
629 }
630 
631 /* here's the real work! */
632 static void netdev_trig_work(struct work_struct *work)
633 {
634 	struct led_netdev_data *trigger_data =
635 		container_of(work, struct led_netdev_data, work.work);
636 	struct rtnl_link_stats64 *dev_stats;
637 	unsigned int new_activity;
638 	struct rtnl_link_stats64 temp;
639 	unsigned long interval;
640 	int invert;
641 
642 	/* If we dont have a device, insure we are off */
643 	if (!trigger_data->net_dev) {
644 		led_set_brightness(trigger_data->led_cdev, LED_OFF);
645 		return;
646 	}
647 
648 	/* If we are not looking for RX/TX then return  */
649 	if (!test_bit(TRIGGER_NETDEV_TX, &trigger_data->mode) &&
650 	    !test_bit(TRIGGER_NETDEV_RX, &trigger_data->mode) &&
651 	    !test_bit(TRIGGER_NETDEV_TX_ERR, &trigger_data->mode) &&
652 	    !test_bit(TRIGGER_NETDEV_RX_ERR, &trigger_data->mode))
653 		return;
654 
655 	dev_stats = dev_get_stats(trigger_data->net_dev, &temp);
656 	new_activity =
657 	    (test_bit(TRIGGER_NETDEV_TX, &trigger_data->mode) ?
658 		dev_stats->tx_packets : 0) +
659 	    (test_bit(TRIGGER_NETDEV_RX, &trigger_data->mode) ?
660 		dev_stats->rx_packets : 0) +
661 	    (test_bit(TRIGGER_NETDEV_TX_ERR, &trigger_data->mode) ?
662 		dev_stats->tx_errors : 0) +
663 	    (test_bit(TRIGGER_NETDEV_RX_ERR, &trigger_data->mode) ?
664 		dev_stats->rx_errors : 0);
665 
666 	if (trigger_data->last_activity != new_activity) {
667 		led_stop_software_blink(trigger_data->led_cdev);
668 
669 		invert = test_bit(TRIGGER_NETDEV_LINK, &trigger_data->mode) ||
670 			 test_bit(TRIGGER_NETDEV_LINK_10, &trigger_data->mode) ||
671 			 test_bit(TRIGGER_NETDEV_LINK_100, &trigger_data->mode) ||
672 			 test_bit(TRIGGER_NETDEV_LINK_1000, &trigger_data->mode) ||
673 			 test_bit(TRIGGER_NETDEV_LINK_2500, &trigger_data->mode) ||
674 			 test_bit(TRIGGER_NETDEV_LINK_5000, &trigger_data->mode) ||
675 			 test_bit(TRIGGER_NETDEV_LINK_10000, &trigger_data->mode) ||
676 			 test_bit(TRIGGER_NETDEV_HALF_DUPLEX, &trigger_data->mode) ||
677 			 test_bit(TRIGGER_NETDEV_FULL_DUPLEX, &trigger_data->mode);
678 		interval = jiffies_to_msecs(
679 				atomic_read(&trigger_data->interval));
680 		/* base state is ON (link present) */
681 		led_blink_set_oneshot(trigger_data->led_cdev,
682 				      &interval,
683 				      &interval,
684 				      invert);
685 		trigger_data->last_activity = new_activity;
686 	}
687 
688 	schedule_delayed_work(&trigger_data->work,
689 			(atomic_read(&trigger_data->interval)*2));
690 }
691 
692 static int netdev_trig_activate(struct led_classdev *led_cdev)
693 {
694 	struct led_netdev_data *trigger_data;
695 	unsigned long mode = 0;
696 	struct device *dev;
697 	int rc;
698 
699 	trigger_data = kzalloc_obj(struct led_netdev_data);
700 	if (!trigger_data)
701 		return -ENOMEM;
702 
703 	mutex_init(&trigger_data->lock);
704 
705 	trigger_data->notifier.notifier_call = netdev_trig_notify;
706 	trigger_data->notifier.priority = 10;
707 
708 	INIT_DELAYED_WORK(&trigger_data->work, netdev_trig_work);
709 
710 	trigger_data->led_cdev = led_cdev;
711 	trigger_data->net_dev = NULL;
712 	trigger_data->device_name[0] = 0;
713 
714 	trigger_data->mode = 0;
715 	atomic_set(&trigger_data->interval, msecs_to_jiffies(NETDEV_LED_DEFAULT_INTERVAL));
716 	trigger_data->last_activity = 0;
717 
718 	/* Check if hw control is active by default on the LED.
719 	 * Init already enabled mode in hw control.
720 	 */
721 	if (supports_hw_control(led_cdev)) {
722 		dev = led_cdev->hw_control_get_device(led_cdev);
723 		if (dev) {
724 			const char *name = dev_name(dev);
725 
726 			trigger_data->hw_control = true;
727 			set_device_name(trigger_data, name, strlen(name));
728 
729 			rc = led_cdev->hw_control_get(led_cdev, &mode);
730 			if (!rc)
731 				trigger_data->mode = mode;
732 		}
733 	}
734 
735 	led_set_trigger_data(led_cdev, trigger_data);
736 
737 	rc = register_netdevice_notifier(&trigger_data->notifier);
738 	if (rc)
739 		kfree(trigger_data);
740 
741 	return rc;
742 }
743 
744 static void netdev_trig_deactivate(struct led_classdev *led_cdev)
745 {
746 	struct led_netdev_data *trigger_data = led_get_trigger_data(led_cdev);
747 
748 	unregister_netdevice_notifier(&trigger_data->notifier);
749 
750 	cancel_delayed_work_sync(&trigger_data->work);
751 
752 	dev_put(trigger_data->net_dev);
753 
754 	kfree(trigger_data);
755 }
756 
757 static struct led_trigger netdev_led_trigger = {
758 	.name = "netdev",
759 	.activate = netdev_trig_activate,
760 	.deactivate = netdev_trig_deactivate,
761 	.groups = netdev_trig_groups,
762 };
763 
764 module_led_trigger(netdev_led_trigger);
765 
766 MODULE_AUTHOR("Ben Whitten <ben.whitten@gmail.com>");
767 MODULE_AUTHOR("Oliver Jowett <oliver@opencloud.com>");
768 MODULE_DESCRIPTION("Netdev LED trigger");
769 MODULE_LICENSE("GPL v2");
770 MODULE_ALIAS("ledtrig:netdev");
771