From: Daniel Hodges <hodges.daniel.scott@gmail.com>
To: hodges.daniel.scott@gmail.com
Cc: ast@kernel.org, bpf@vger.kernel.org, daniel@iogearbox.net,
lee@kernel.org, linux-kernel@vger.kernel.org,
linux-leds@vger.kernel.org, pavel@ucw.cz
Subject: [PATCH v2 3/3] leds: trigger: Add documentation for ledtrig-bpf
Date: Mon, 25 Mar 2024 21:14:47 -0400 [thread overview]
Message-ID: <fd8c1022eda25ff80b27ff3bf7fa15dbd6947ebf.1711415233.git.hodges.daniel.scott@gmail.com> (raw)
In-Reply-To: <cover.1711415233.git.hodges.daniel.scott@gmail.com>
Update the documentation for led triggers to include the BPF LED
trigger.
Signed-off-by: Daniel Hodges <hodges.daniel.scott@gmail.com>
---
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.2
next prev parent reply other threads:[~2024-03-26 1:15 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-22 14:08 [PATCH 0/3] leds: trigger: Add led trigger for bpf Daniel Hodges
2024-03-22 14:08 ` [PATCH 1/3] leds: trigger: legtrig-bpf: Add ledtrig-bpf module Daniel Hodges
2024-03-22 15:24 ` Yonghong Song
2024-03-22 21:52 ` Pavel Machek
2024-03-23 19:19 ` Alexei Starovoitov
2024-03-23 22:25 ` Andrew Lunn
2024-03-27 1:53 ` Daniel Hodges
2024-03-23 22:18 ` Andrew Lunn
2024-03-24 2:15 ` Daniel Hodges
2024-03-24 2:15 ` Daniel Hodges
2024-03-26 1:14 ` [PATCH v2 0/3] leds: trigger: legtrig-bpf: Add ledtrig-bpf trigger Daniel Hodges
2024-03-26 1:14 ` [PATCH v2 1/3] " Daniel Hodges
2024-04-11 10:40 ` Lee Jones
2024-03-26 1:14 ` [PATCH v2 2/3] selftests/bpf: Add selftests for bpf led programs Daniel Hodges
2024-03-26 1:14 ` Daniel Hodges [this message]
2024-04-11 10:46 ` [PATCH v2 3/3] leds: trigger: Add documentation for ledtrig-bpf Lee Jones
2024-03-22 14:08 ` [PATCH 2/3] selftests/bpf: Add selftests for bpf led programs Daniel Hodges
2024-03-22 14:08 ` [PATCH 3/3] leds: trigger: Add documentation for ledtrig-bpf Daniel Hodges
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=fd8c1022eda25ff80b27ff3bf7fa15dbd6947ebf.1711415233.git.hodges.daniel.scott@gmail.com \
--to=hodges.daniel.scott@gmail.com \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=daniel@iogearbox.net \
--cc=lee@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-leds@vger.kernel.org \
--cc=pavel@ucw.cz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox