[PATCH 3/3] leds: trigger: Add documentation for ledtrig-bpf
From: Daniel Hodges
Date: Fri Mar 22 2024 - 10:09:41 EST
Update the documentation for led triggers to include the BPF LED
trigger.
Signed-off-by: Daniel Hodges <hodges.daniel.scott@xxxxxxxxx>
---
Documentation/leds/index.rst | 1 +
Documentation/leds/ledtrig-bpf.rst | 13 +++++++++++++
2 files changed, 14 insertions(+)
create mode 100644 Documentation/leds/ledtrig-bpf.rst
diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index 3ade16c18328..2af52a19d6bb 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -10,6 +10,7 @@ LEDs
leds-class
leds-class-flash
leds-class-multicolor
+ ledtrig-bpf
ledtrig-oneshot
ledtrig-transient
ledtrig-usbport
diff --git a/Documentation/leds/ledtrig-bpf.rst b/Documentation/leds/ledtrig-bpf.rst
new file mode 100644
index 000000000000..391a305f69d1
--- /dev/null
+++ b/Documentation/leds/ledtrig-bpf.rst
@@ -0,0 +1,13 @@
+====================
+BPF LED Trigger
+====================
+
+This LED trigger is useful for triggering LEDs from the BPF subsystem. This
+trigger is designed to be used in combination with a BPF program that interacts
+with the trigger via a kfunc. The exported kfuncs will have BTF names that
+start with "bpf_ledtrig_".
+
+The trigger can be activated from user space on led class devices as shown
+below::
+
+ echo bpf > trigger
--
2.43.0