1 From 06f502f57d0d7728f9fa0f157ec5e4111ddb98f6 Mon Sep 17 00:00:00 2001
2 From: Ben Whitten <ben.whitten@gmail.com>
3 Date: Sun, 10 Dec 2017 21:17:55 +0000
4 Subject: [PATCH] leds: trigger: Introduce a NETDEV trigger
6 This commit introduces a NETDEV trigger for named device
7 activity. Available triggers are link, rx, and tx.
9 Signed-off-by: Ben Whitten <ben.whitten@gmail.com>
10 Acked-by: Pavel Machek <pavel@ucw.cz>
11 Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com>
13 .../ABI/testing/sysfs-class-led-trigger-netdev | 45 ++
14 drivers/leds/trigger/Kconfig | 7 +
15 drivers/leds/trigger/Makefile | 1 +
16 drivers/leds/trigger/ledtrig-netdev.c | 496 +++++++++++++++++++++
17 4 files changed, 549 insertions(+)
18 create mode 100644 Documentation/ABI/testing/sysfs-class-led-trigger-netdev
19 create mode 100644 drivers/leds/trigger/ledtrig-netdev.c
22 +++ b/Documentation/ABI/testing/sysfs-class-led-trigger-netdev
24 +What: /sys/class/leds/<led>/device_name
27 +Contact: linux-leds@vger.kernel.org
29 + Specifies the network device name to monitor.
31 +What: /sys/class/leds/<led>/interval
34 +Contact: linux-leds@vger.kernel.org
36 + Specifies the duration of the LED blink in milliseconds.
39 +What: /sys/class/leds/<led>/link
42 +Contact: linux-leds@vger.kernel.org
44 + Signal the link state of the named network device.
45 + If set to 0 (default), the LED's normal state is off.
46 + If set to 1, the LED's normal state reflects the link state
47 + of the named network device.
48 + Setting this value also immediately changes the LED state.
50 +What: /sys/class/leds/<led>/tx
53 +Contact: linux-leds@vger.kernel.org
55 + Signal transmission of data on the named network device.
56 + If set to 0 (default), the LED will not blink on transmission.
57 + If set to 1, the LED will blink for the milliseconds specified
58 + in interval to signal transmission.
60 +What: /sys/class/leds/<led>/rx
63 +Contact: linux-leds@vger.kernel.org
65 + Signal reception of data on the named network device.
66 + If set to 0 (default), the LED will not blink on reception.
67 + If set to 1, the LED will blink for the milliseconds specified
68 + in interval to signal reception.
69 --- a/drivers/leds/trigger/Kconfig
70 +++ b/drivers/leds/trigger/Kconfig
71 @@ -126,4 +126,11 @@ config LEDS_TRIGGER_PANIC
75 +config LEDS_TRIGGER_NETDEV
76 + tristate "LED Netdev Trigger"
77 + depends on NET && LEDS_TRIGGERS
79 + This allows LEDs to be controlled by network device activity.
83 --- a/drivers/leds/trigger/Makefile
84 +++ b/drivers/leds/trigger/Makefile
85 @@ -10,3 +10,4 @@ obj-$(CONFIG_LEDS_TRIGGER_DEFAULT_ON) +=
86 obj-$(CONFIG_LEDS_TRIGGER_TRANSIENT) += ledtrig-transient.o
87 obj-$(CONFIG_LEDS_TRIGGER_CAMERA) += ledtrig-camera.o
88 obj-$(CONFIG_LEDS_TRIGGER_PANIC) += ledtrig-panic.o
89 +obj-$(CONFIG_LEDS_TRIGGER_NETDEV) += ledtrig-netdev.o
91 +++ b/drivers/leds/trigger/ledtrig-netdev.c
93 +// SPDX-License-Identifier: GPL-2.0
94 +// Copyright 2017 Ben Whitten <ben.whitten@gmail.com>
95 +// Copyright 2007 Oliver Jowett <oliver@opencloud.com>
97 +// LED Kernel Netdev Trigger
99 +// Toggles the LED to reflect the link and traffic state of a named net device
101 +// Derived from ledtrig-timer.c which is:
102 +// Copyright 2005-2006 Openedhand Ltd.
103 +// Author: Richard Purdie <rpurdie@openedhand.com>
105 +#include <linux/atomic.h>
106 +#include <linux/ctype.h>
107 +#include <linux/device.h>
108 +#include <linux/init.h>
109 +#include <linux/jiffies.h>
110 +#include <linux/kernel.h>
111 +#include <linux/leds.h>
112 +#include <linux/list.h>
113 +#include <linux/module.h>
114 +#include <linux/netdevice.h>
115 +#include <linux/spinlock.h>
116 +#include <linux/timer.h>
117 +#include "../leds.h"
120 + * Configurable sysfs attributes:
122 + * device_name - network device name to monitor
123 + * interval - duration of LED blink, in milliseconds
124 + * link - LED's normal state reflects whether the link is up
125 + * (has carrier) or not
126 + * tx - LED blinks on transmitted data
127 + * rx - LED blinks on receive data
131 +struct led_netdev_data {
134 + struct delayed_work work;
135 + struct notifier_block notifier;
137 + struct led_classdev *led_cdev;
138 + struct net_device *net_dev;
140 + char device_name[IFNAMSIZ];
142 + unsigned int last_activity;
144 + unsigned long mode;
145 +#define NETDEV_LED_LINK 0
146 +#define NETDEV_LED_TX 1
147 +#define NETDEV_LED_RX 2
148 +#define NETDEV_LED_MODE_LINKUP 3
151 +enum netdev_led_attr {
157 +static void set_baseline_state(struct led_netdev_data *trigger_data)
159 + int current_brightness;
160 + struct led_classdev *led_cdev = trigger_data->led_cdev;
162 + current_brightness = led_cdev->brightness;
163 + if (current_brightness)
164 + led_cdev->blink_brightness = current_brightness;
165 + if (!led_cdev->blink_brightness)
166 + led_cdev->blink_brightness = led_cdev->max_brightness;
168 + if (!test_bit(NETDEV_LED_MODE_LINKUP, &trigger_data->mode))
169 + led_set_brightness(led_cdev, LED_OFF);
171 + if (test_bit(NETDEV_LED_LINK, &trigger_data->mode))
172 + led_set_brightness(led_cdev,
173 + led_cdev->blink_brightness);
175 + led_set_brightness(led_cdev, LED_OFF);
177 + /* If we are looking for RX/TX start periodically
180 + if (test_bit(NETDEV_LED_TX, &trigger_data->mode) ||
181 + test_bit(NETDEV_LED_RX, &trigger_data->mode))
182 + schedule_delayed_work(&trigger_data->work, 0);
186 +static ssize_t device_name_show(struct device *dev,
187 + struct device_attribute *attr, char *buf)
189 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
190 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
193 + spin_lock_bh(&trigger_data->lock);
194 + len = sprintf(buf, "%s\n", trigger_data->device_name);
195 + spin_unlock_bh(&trigger_data->lock);
200 +static ssize_t device_name_store(struct device *dev,
201 + struct device_attribute *attr, const char *buf,
204 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
205 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
207 + if (size >= IFNAMSIZ)
210 + cancel_delayed_work_sync(&trigger_data->work);
212 + spin_lock_bh(&trigger_data->lock);
214 + if (trigger_data->net_dev) {
215 + dev_put(trigger_data->net_dev);
216 + trigger_data->net_dev = NULL;
219 + strncpy(trigger_data->device_name, buf, size);
220 + if (size > 0 && trigger_data->device_name[size - 1] == '\n')
221 + trigger_data->device_name[size - 1] = 0;
223 + if (trigger_data->device_name[0] != 0)
224 + trigger_data->net_dev =
225 + dev_get_by_name(&init_net, trigger_data->device_name);
227 + clear_bit(NETDEV_LED_MODE_LINKUP, &trigger_data->mode);
228 + if (trigger_data->net_dev != NULL)
229 + if (netif_carrier_ok(trigger_data->net_dev))
230 + set_bit(NETDEV_LED_MODE_LINKUP, &trigger_data->mode);
232 + trigger_data->last_activity = 0;
234 + set_baseline_state(trigger_data);
235 + spin_unlock_bh(&trigger_data->lock);
240 +static DEVICE_ATTR_RW(device_name);
242 +static ssize_t netdev_led_attr_show(struct device *dev, char *buf,
243 + enum netdev_led_attr attr)
245 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
246 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
250 + case NETDEV_ATTR_LINK:
251 + bit = NETDEV_LED_LINK;
253 + case NETDEV_ATTR_TX:
254 + bit = NETDEV_LED_TX;
256 + case NETDEV_ATTR_RX:
257 + bit = NETDEV_LED_RX;
263 + return sprintf(buf, "%u\n", test_bit(bit, &trigger_data->mode));
266 +static ssize_t netdev_led_attr_store(struct device *dev, const char *buf,
267 + size_t size, enum netdev_led_attr attr)
269 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
270 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
271 + unsigned long state;
275 + ret = kstrtoul(buf, 0, &state);
280 + case NETDEV_ATTR_LINK:
281 + bit = NETDEV_LED_LINK;
283 + case NETDEV_ATTR_TX:
284 + bit = NETDEV_LED_TX;
286 + case NETDEV_ATTR_RX:
287 + bit = NETDEV_LED_RX;
293 + cancel_delayed_work_sync(&trigger_data->work);
296 + set_bit(bit, &trigger_data->mode);
298 + clear_bit(bit, &trigger_data->mode);
300 + set_baseline_state(trigger_data);
305 +static ssize_t link_show(struct device *dev,
306 + struct device_attribute *attr, char *buf)
308 + return netdev_led_attr_show(dev, buf, NETDEV_ATTR_LINK);
311 +static ssize_t link_store(struct device *dev,
312 + struct device_attribute *attr, const char *buf, size_t size)
314 + return netdev_led_attr_store(dev, buf, size, NETDEV_ATTR_LINK);
317 +static DEVICE_ATTR_RW(link);
319 +static ssize_t tx_show(struct device *dev,
320 + struct device_attribute *attr, char *buf)
322 + return netdev_led_attr_show(dev, buf, NETDEV_ATTR_TX);
325 +static ssize_t tx_store(struct device *dev,
326 + struct device_attribute *attr, const char *buf, size_t size)
328 + return netdev_led_attr_store(dev, buf, size, NETDEV_ATTR_TX);
331 +static DEVICE_ATTR_RW(tx);
333 +static ssize_t rx_show(struct device *dev,
334 + struct device_attribute *attr, char *buf)
336 + return netdev_led_attr_show(dev, buf, NETDEV_ATTR_RX);
339 +static ssize_t rx_store(struct device *dev,
340 + struct device_attribute *attr, const char *buf, size_t size)
342 + return netdev_led_attr_store(dev, buf, size, NETDEV_ATTR_RX);
345 +static DEVICE_ATTR_RW(rx);
347 +static ssize_t interval_show(struct device *dev,
348 + struct device_attribute *attr, char *buf)
350 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
351 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
353 + return sprintf(buf, "%u\n",
354 + jiffies_to_msecs(atomic_read(&trigger_data->interval)));
357 +static ssize_t interval_store(struct device *dev,
358 + struct device_attribute *attr, const char *buf,
361 + struct led_classdev *led_cdev = dev_get_drvdata(dev);
362 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
363 + unsigned long value;
366 + ret = kstrtoul(buf, 0, &value);
370 + /* impose some basic bounds on the timer interval */
371 + if (value >= 5 && value <= 10000) {
372 + cancel_delayed_work_sync(&trigger_data->work);
374 + atomic_set(&trigger_data->interval, msecs_to_jiffies(value));
375 + set_baseline_state(trigger_data); /* resets timer */
381 +static DEVICE_ATTR_RW(interval);
383 +static int netdev_trig_notify(struct notifier_block *nb,
384 + unsigned long evt, void *dv)
386 + struct net_device *dev =
387 + netdev_notifier_info_to_dev((struct netdev_notifier_info *)dv);
388 + struct led_netdev_data *trigger_data = container_of(nb,
393 + if (evt != NETDEV_UP && evt != NETDEV_DOWN && evt != NETDEV_CHANGE
394 + && evt != NETDEV_REGISTER && evt != NETDEV_UNREGISTER
395 + && evt != NETDEV_CHANGENAME)
396 + return NOTIFY_DONE;
398 + if (strcmp(dev->name, trigger_data->device_name))
399 + return NOTIFY_DONE;
401 + cancel_delayed_work_sync(&trigger_data->work);
403 + spin_lock_bh(&trigger_data->lock);
405 + clear_bit(NETDEV_LED_MODE_LINKUP, &trigger_data->mode);
407 + case NETDEV_REGISTER:
408 + if (trigger_data->net_dev)
409 + dev_put(trigger_data->net_dev);
411 + trigger_data->net_dev = dev;
413 + case NETDEV_CHANGENAME:
414 + case NETDEV_UNREGISTER:
415 + if (trigger_data->net_dev) {
416 + dev_put(trigger_data->net_dev);
417 + trigger_data->net_dev = NULL;
421 + case NETDEV_CHANGE:
422 + if (netif_carrier_ok(dev))
423 + set_bit(NETDEV_LED_MODE_LINKUP, &trigger_data->mode);
427 + set_baseline_state(trigger_data);
429 + spin_unlock_bh(&trigger_data->lock);
431 + return NOTIFY_DONE;
434 +/* here's the real work! */
435 +static void netdev_trig_work(struct work_struct *work)
437 + struct led_netdev_data *trigger_data = container_of(work,
441 + struct rtnl_link_stats64 *dev_stats;
442 + unsigned int new_activity;
443 + struct rtnl_link_stats64 temp;
444 + unsigned long interval;
447 + /* If we dont have a device, insure we are off */
448 + if (!trigger_data->net_dev) {
449 + led_set_brightness(trigger_data->led_cdev, LED_OFF);
453 + /* If we are not looking for RX/TX then return */
454 + if (!test_bit(NETDEV_LED_TX, &trigger_data->mode) &&
455 + !test_bit(NETDEV_LED_RX, &trigger_data->mode))
458 + dev_stats = dev_get_stats(trigger_data->net_dev, &temp);
460 + (test_bit(NETDEV_LED_TX, &trigger_data->mode) ?
461 + dev_stats->tx_packets : 0) +
462 + (test_bit(NETDEV_LED_RX, &trigger_data->mode) ?
463 + dev_stats->rx_packets : 0);
465 + if (trigger_data->last_activity != new_activity) {
466 + led_stop_software_blink(trigger_data->led_cdev);
468 + invert = test_bit(NETDEV_LED_LINK, &trigger_data->mode);
469 + interval = jiffies_to_msecs(
470 + atomic_read(&trigger_data->interval));
471 + /* base state is ON (link present) */
472 + led_blink_set_oneshot(trigger_data->led_cdev,
476 + trigger_data->last_activity = new_activity;
479 + schedule_delayed_work(&trigger_data->work,
480 + (atomic_read(&trigger_data->interval)*2));
483 +static void netdev_trig_activate(struct led_classdev *led_cdev)
485 + struct led_netdev_data *trigger_data;
488 + trigger_data = kzalloc(sizeof(struct led_netdev_data), GFP_KERNEL);
492 + spin_lock_init(&trigger_data->lock);
494 + trigger_data->notifier.notifier_call = netdev_trig_notify;
495 + trigger_data->notifier.priority = 10;
497 + INIT_DELAYED_WORK(&trigger_data->work, netdev_trig_work);
499 + trigger_data->led_cdev = led_cdev;
500 + trigger_data->net_dev = NULL;
501 + trigger_data->device_name[0] = 0;
503 + trigger_data->mode = 0;
504 + atomic_set(&trigger_data->interval, msecs_to_jiffies(50));
505 + trigger_data->last_activity = 0;
507 + led_cdev->trigger_data = trigger_data;
509 + rc = device_create_file(led_cdev->dev, &dev_attr_device_name);
512 + rc = device_create_file(led_cdev->dev, &dev_attr_link);
514 + goto err_out_device_name;
515 + rc = device_create_file(led_cdev->dev, &dev_attr_rx);
518 + rc = device_create_file(led_cdev->dev, &dev_attr_tx);
521 + rc = device_create_file(led_cdev->dev, &dev_attr_interval);
524 + rc = register_netdevice_notifier(&trigger_data->notifier);
526 + goto err_out_interval;
530 + device_remove_file(led_cdev->dev, &dev_attr_interval);
532 + device_remove_file(led_cdev->dev, &dev_attr_tx);
534 + device_remove_file(led_cdev->dev, &dev_attr_rx);
536 + device_remove_file(led_cdev->dev, &dev_attr_link);
537 +err_out_device_name:
538 + device_remove_file(led_cdev->dev, &dev_attr_device_name);
540 + led_cdev->trigger_data = NULL;
541 + kfree(trigger_data);
544 +static void netdev_trig_deactivate(struct led_classdev *led_cdev)
546 + struct led_netdev_data *trigger_data = led_cdev->trigger_data;
548 + if (trigger_data) {
549 + unregister_netdevice_notifier(&trigger_data->notifier);
551 + device_remove_file(led_cdev->dev, &dev_attr_device_name);
552 + device_remove_file(led_cdev->dev, &dev_attr_link);
553 + device_remove_file(led_cdev->dev, &dev_attr_rx);
554 + device_remove_file(led_cdev->dev, &dev_attr_tx);
555 + device_remove_file(led_cdev->dev, &dev_attr_interval);
557 + cancel_delayed_work_sync(&trigger_data->work);
559 + if (trigger_data->net_dev)
560 + dev_put(trigger_data->net_dev);
562 + kfree(trigger_data);
566 +static struct led_trigger netdev_led_trigger = {
568 + .activate = netdev_trig_activate,
569 + .deactivate = netdev_trig_deactivate,
572 +static int __init netdev_trig_init(void)
574 + return led_trigger_register(&netdev_led_trigger);
577 +static void __exit netdev_trig_exit(void)
579 + led_trigger_unregister(&netdev_led_trigger);
582 +module_init(netdev_trig_init);
583 +module_exit(netdev_trig_exit);
585 +MODULE_AUTHOR("Ben Whitten <ben.whitten@gmail.com>");
586 +MODULE_AUTHOR("Oliver Jowett <oliver@opencloud.com>");
587 +MODULE_DESCRIPTION("Netdev LED trigger");
588 +MODULE_LICENSE("GPL v2");