[PATCH net-next v4 4/8] net: Add helpers for netdev LEDs

Andrew Lunn
2024-04-06T20:14:09Z

Add a set of helpers for parsing the standard device tree properties
for LEDs as part of an ethernet device, and registering them with the
LED subsystem. This code can be used by any sort of netdev driver,
including plain MAC, DSA switches or pure switchdev switch driver.

The MAC driver should call netdev_leds_teardown() before destroying
the netdev to ensure the ops cannot be called after unbinding the
device.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
include/net/netdev_leds.h | 50 ++++++++++++
net/Kconfig | 11 +++
net/core/Makefile | 1 +
net/core/netdev-leds.c | 199 ++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 261 insertions(+)

diff --git a/include/net/netdev_leds.h b/include/net/netdev_leds.h
new file mode 100644
index 000000000000..30053891561c
--- /dev/null
+++ b/include/net/netdev_leds.h
@@ -0,0 +1,50 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * Helpers used for creating and managing LEDs on a netdev MAC
+ * driver.
+ */
+
+#ifndef _NET_NETDEV_LEDS_H
+#define _NET_NETDEV_LEDS_H
+
+#include <linux/leds.h>
+#include <linux/types.h>
+
+struct net_device;
+struct list_head;
+
+struct netdev_leds_ops {
+ int (*brightness_set)(struct net_device *ndev, u8 led,
+ enum led_brightness brightness);
+ int (*blink_set)(struct net_device *ndev, u8 led,
+ unsigned long *delay_on, unsigned long *delay_off);
+ int (*hw_control_is_supported)(struct net_device *ndev, u8 led,
+ unsigned long flags);
+ int (*hw_control_set)(struct net_device *ndev, u8 led,
+ unsigned long flags);
+ int (*hw_control_get)(struct net_device *ndev, u8 led,
+ unsigned long *flags);
+};
+
+#ifdef CONFIG_NETDEV_LEDS
+int netdev_leds_setup(struct net_device *ndev, struct device_node *np,
+ struct list_head *list, struct netdev_leds_ops *ops,
+ int max_leds);
+
+void netdev_leds_teardown(struct list_head *list);
+
+#else
+static inline int netdev_leds_setup(struct net_device *ndev,
+ struct device_node *np,
+ struct list_head *list,
+ struct netdev_leds_ops *ops)
+{
+ return 0;
+}
+
+static inline void netdev_leds_teardown(struct list_head *list)
+{
+}
+#endif /* CONFIG_NETDEV_LEDS */
+
+#endif /* _NET_PORT_LEDS_H */
diff --git a/net/Kconfig b/net/Kconfig
index 3e57ccf0da27..5301b95744cd 100644
--- a/net/Kconfig
+++ b/net/Kconfig
@@ -516,4 +516,15 @@ config NET_TEST

If unsure, say N.

+config NETDEV_LEDS
+ bool "NETDEV helper code for MAC LEDs"
+ select LEDS_CLASS
+ select LEDS_TRIGGERS
+ select LEDS_TRIGGER_NETDEV
+ help
+ NICs and switches often contain LED controllers. When the LEDs
+ are part of the MAC, the MAC driver, aka netdev driver, should
+ make the LEDs available. NETDEV_LEDS offers a small library
+ of code to help MAC drivers do this.
+
endif # if NET
diff --git a/net/core/Makefile b/net/core/Makefile
index 21d6fbc7e884..d04ce07541b5 100644
--- a/net/core/Makefile
+++ b/net/core/Makefile
@@ -42,3 +42,4 @@ obj-$(CONFIG_BPF_SYSCALL) += sock_map.o
obj-$(CONFIG_BPF_SYSCALL) += bpf_sk_storage.o
obj-$(CONFIG_OF) += of_net.o
obj-$(CONFIG_NET_TEST) += net_test.o
+obj-$(CONFIG_NETDEV_LEDS) += netdev-leds.o
diff --git a/net/core/netdev-leds.c b/net/core/netdev-leds.c
new file mode 100644
index 000000000000..bea981ff42ea
--- /dev/null
+++ b/net/core/netdev-leds.c
@@ -0,0 +1,199 @@
+// SPDX-License-Identifier: GPL-2.0+
+
+#include <linux/device.h>
+#include <linux/err.h>
+#include <linux/leds.h>
+#include <linux/netdevice.h>
+#include <linux/of.h>
+#include <linux/slab.h>
+#include <net/netdev_leds.h>
+
+struct netdev_led {
+ struct list_head led_list;
+ struct led_classdev led_cdev;
+ struct netdev_leds_ops *ops;
+ struct net_device *ndev;
+ u8 index;
+};
+
+#define to_netdev_led(d) container_of(d, struct netdev_led, led_cdev)
+
+static int netdev_brightness_set(struct led_classdev *led_cdev,
+ enum led_brightness value)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return netdev_led->ops->brightness_set(netdev_led->ndev,
+ netdev_led->index,
+ value);
+}
+
+static int netdev_blink_set(struct led_classdev *led_cdev,
+ unsigned long *delay_on, unsigned long *delay_off)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return netdev_led->ops->blink_set(netdev_led->ndev,
+ netdev_led->index,
+ delay_on, delay_off);
+}
+
+static __maybe_unused int
+netdev_hw_control_is_supported(struct led_classdev *led_cdev,
+ unsigned long flags)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return netdev_led->ops->hw_control_is_supported(netdev_led->ndev,
+ netdev_led->index,
+ flags);
+}
+
+static __maybe_unused int netdev_hw_control_set(struct led_classdev *led_cdev,
+ unsigned long flags)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return netdev_led->ops->hw_control_set(netdev_led->ndev,
+ netdev_led->index,
+ flags);
+}
+
+static __maybe_unused int netdev_hw_control_get(struct led_classdev *led_cdev,
+ unsigned long *flags)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return netdev_led->ops->hw_control_get(netdev_led->ndev,
+ netdev_led->index,
+ flags);
+}
+
+static struct device *
+netdev_hw_control_get_device(struct led_classdev *led_cdev)
+{
+ struct netdev_led *netdev_led = to_netdev_led(led_cdev);
+
+ return &netdev_led->ndev->dev;
+}
+
+static int netdev_led_setup(struct net_device *ndev, struct device_node *led,
+ struct list_head *list, struct netdev_leds_ops *ops,
+ int max_leds)
+{
+ struct led_init_data init_data = {};
+ struct device *dev = &ndev->dev;
+ struct netdev_led *netdev_led;
+ struct led_classdev *cdev;
+ u32 index;
+ int err;
+
+ netdev_led = kzalloc(sizeof(*netdev_led), GFP_KERNEL);
+ if (!netdev_led)
+ return -ENOMEM;
+
+ netdev_led->ndev = ndev;
+ netdev_led->ops = ops;
+ cdev = &netdev_led->led_cdev;
+
+ err = of_property_read_u32(led, "reg", &index);
+ if (err)
+ return err;
+
+ if (index >= max_leds)
+ return -EINVAL;
+
+ netdev_led->index = index;
+
+ if (ops->brightness_set)
+ cdev->brightness_set_blocking = netdev_brightness_set;
+ if (ops->blink_set)
+ cdev->blink_set = netdev_blink_set;
+#ifdef CONFIG_LEDS_TRIGGERS
+ if (ops->hw_control_is_supported)
+ cdev->hw_control_is_supported = netdev_hw_control_is_supported;
+ if (ops->hw_control_set)
+ cdev->hw_control_set = netdev_hw_control_set;
+ if (ops->hw_control_get)
+ cdev->hw_control_get = netdev_hw_control_get;
+ cdev->hw_control_trigger = "netdev";
+#endif
+ cdev->hw_control_get_device = netdev_hw_control_get_device;
+ cdev->max_brightness = 1;
+ init_data.fwnode = of_fwnode_handle(led);
+ init_data.devname_mandatory = true;
+
+ init_data.devicename = dev_name(dev);
+ err = led_classdev_register_ext(dev, cdev, &init_data);
+ if (err)
+ return err;
+
+ INIT_LIST_HEAD(&netdev_led->led_list);
+ list_add(&netdev_led->led_list, list);
+
+ return 0;
+}
+
+/**
+ * netdev_leds_setup - Parse DT node and create LEDs for netdev
+ *
+ * @ndev: struct netdev for the MAC
+ * @np: ethernet-node in device tree
+ * @list: list to add LEDs to
+ * @ops: structure of ops to manipulate the LED.
+ * @max_leds: maximum number of LEDs support by netdev.
+ *
+ * Parse the device tree node, as described in
+ * ethernet-controller.yaml, and find any LEDs. For each LED found,
+ * ensure the reg value is less than max_leds, create an LED and
+ * register it with the LED subsystem. The LED will be added to the
+ * list, which should be unique to the netdev. The ops structure
+ * contains the callbacks needed to control the LEDs.
+ *
+ * Return 0 in success, otherwise an negative error code.
+ */
+int netdev_leds_setup(struct net_device *ndev, struct device_node *np,
+ struct list_head *list, struct netdev_leds_ops *ops,
+ int max_leds)
+{
+ struct device_node *leds, *led;
+ int err;
+
+ leds = of_get_child_by_name(np, "leds");
+ if (!leds)
+ return 0;
+
+ for_each_available_child_of_node(leds, led) {
+ err = netdev_led_setup(ndev, led, list, ops, max_leds);
+ if (err) {
+ of_node_put(leds);
+ of_node_put(led);
+ return err;
+ }
+ }
+ of_node_put(leds);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(netdev_leds_setup);
+
+/**
+ * netdev_leds_teardown - Remove LEDs for a netdev
+ *
+ * @list: list to add LEDs to teardown
+ *
+ * Unregister all LEDs from the given list of LEDS, freeing up any
+ * allocated memory.
+ */
+void netdev_leds_teardown(struct list_head *list)
+{
+ struct netdev_led *netdev_led;
+ struct led_classdev *cdev;
+
+ list_for_each_entry(netdev_led, list, led_list) {
+ cdev = &netdev_led->led_cdev;
+ led_classdev_unregister(cdev);
+ kfree(netdev_led);
+ }
+}
+EXPORT_SYMBOL_GPL(netdev_leds_teardown);

--
2.43.0