linux-input.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Benjamin Tissoires <bentiss@kernel.org>
To: Shuah Khan <shuah@kernel.org>, Jiri Kosina <jikos@kernel.org>,
	 Jonathan Corbet <corbet@lwn.net>,
	Alexei Starovoitov <ast@kernel.org>
Cc: linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	 bpf@vger.kernel.org, linux-input@vger.kernel.org,
	linux-doc@vger.kernel.org,
	 Benjamin Tissoires <bentiss@kernel.org>
Subject: [PATCH HID v3 11/16] Documentation: HID: add a small blurb on udev-hid-bpf
Date: Sat, 08 Jun 2024 11:01:23 +0200	[thread overview]
Message-ID: <20240608-hid_bpf_struct_ops-v3-11-6ac6ade58329@kernel.org> (raw)
In-Reply-To: <20240608-hid_bpf_struct_ops-v3-0-6ac6ade58329@kernel.org>

This is the current decision we took: we don't provide automatic loading
of HID-BPF by the kernel directly, but rely on an external tool for it.

This tool is currently udev-hid-bpf, so let's make people aware of it.

Signed-off-by: Benjamin Tissoires <bentiss@kernel.org>

---

no changes in v3

no changes in v2
---
 Documentation/hid/hid-bpf.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/Documentation/hid/hid-bpf.rst b/Documentation/hid/hid-bpf.rst
index 456e15097d87..8ae8f49801cb 100644
--- a/Documentation/hid/hid-bpf.rst
+++ b/Documentation/hid/hid-bpf.rst
@@ -129,6 +129,23 @@ When a BPF program needs to emit input events, it needs to talk with the HID
 protocol, and rely on the HID kernel processing to translate the HID data into
 input events.
 
+In-tree HID-BPF programs and ``udev-hid-bpf``
+=============================================
+
+Official device fixes are shipped in the kernel tree as source in the
+``drivers/hid/bpf/progs`` directory. This allows to add selftests to them in
+``tools/testing/selftests/hid``.
+
+However, the compilation of these objects is not part of a regular kernel compilation
+given that they need an external tool to be loaded. This tool is currently
+`udev-hid-bpf <https://libevdev.pages.freedesktop.org/udev-hid-bpf/index.html>`_.
+
+For convenience, that external repository duplicates the files from here in
+``drivers/hid/bpf/progs`` into its own ``src/bpf/stable`` directory. This allows
+distributions to not have to pull the entire kernel source tree to ship and package
+those HID-BPF fixes. ``udev-hid-bpf`` also has capabilities of handling multiple
+objects files depending on the kernel the user is running.
+
 Available types of programs
 ===========================
 

-- 
2.44.0


  parent reply	other threads:[~2024-06-08  9:01 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-08  9:01 [PATCH HID v3 00/16] HID: convert HID-BPF into using bpf_struct_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 01/16] HID: rename struct hid_bpf_ops into hid_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 02/16] HID: bpf: add hid_get/put_device() helpers Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 03/16] HID: bpf: implement HID-BPF through bpf_struct_ops Benjamin Tissoires
2024-06-10 18:34   ` Alexei Starovoitov
2024-06-14  9:25     ` Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 04/16] selftests/hid: convert the hid_bpf selftests with struct_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 05/16] HID: samples: convert the 2 HID-BPF samples into struct_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 06/16] HID: bpf: add defines for HID-BPF SEC in in-tree bpf fixes Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 07/16] HID: bpf: convert in-tree fixes into struct_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 08/16] HID: bpf: remove tracing HID-BPF capability Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 09/16] selftests/hid: add subprog call test Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 10/16] Documentation: HID: amend HID-BPF for struct_ops Benjamin Tissoires
2024-06-08  9:01 ` Benjamin Tissoires [this message]
2024-06-08  9:01 ` [PATCH HID v3 12/16] HID: bpf: Artist24: remove unused variable Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 13/16] HID: bpf: error on warnings when compiling bpf objects Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 14/16] bpf: allow bpf helpers to be used into HID-BPF struct_ops Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 15/16] HID: bpf: rework hid_bpf_ops_btf_struct_access Benjamin Tissoires
2024-06-10 18:39   ` Alexei Starovoitov
2024-06-11 16:57     ` Benjamin Tissoires
2024-06-08  9:01 ` [PATCH HID v3 16/16] HID: bpf: make part of struct hid_device writable Benjamin Tissoires
2024-06-14  9:26 ` [PATCH HID v3 00/16] HID: convert HID-BPF into using bpf_struct_ops Benjamin Tissoires

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=20240608-hid_bpf_struct_ops-v3-11-6ac6ade58329@kernel.org \
    --to=bentiss@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=corbet@lwn.net \
    --cc=jikos@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=shuah@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).