HID: bpf: doc fixes for hid_hw_request() hooks

We had the following errors while doing make htmldocs:

Documentation/hid/hid-bpf:185: include/linux/hid_bpf.h:167:
	ERROR: Unexpected indentation.

Also ensure consistency with the rest of the __u64 vs u64.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: 9286675a2aed ("HID: bpf: add HID-BPF hooks for hid_hw_output_report")
Link: https://patch.msgid.link/20240701-fix-cki-v2-4-20564e2e1393@kernel.org
Signed-off-by: Benjamin Tissoires <bentiss@kernel.org>

diff --git a/drivers/hid/bpf/hid_bpf_dispatch.c b/drivers/hid/bpf/hid_bpf_dispatch.c
index a36e680399fea8460850daeded22540f9fc0a556..a272a086c9508161020ad528faa949d20d43b941 100644 (file)
--- a/drivers/hid/bpf/hid_bpf_dispatch.c
+++ b/drivers/hid/bpf/hid_bpf_dispatch.c
@@ -115,7 +115,7 @@ out:
 EXPORT_SYMBOL_GPL(dispatch_hid_bpf_raw_requests);
 
 int dispatch_hid_bpf_output_report(struct hid_device *hdev,
-                                  __u8 *buf, u32 size, __u64 source,
+                                  __u8 *buf, u32 size, u64 source,
                                   bool from_bpf)
 {
        struct hid_bpf_ctx_kern ctx_kern = {

diff --git a/include/linux/hid_bpf.h b/include/linux/hid_bpf.h
index c30c31b79419dbd6fd629ceb364b402525612797..9ca96fc904491622d8693ce208c77790cbed0999 100644 (file)
--- a/include/linux/hid_bpf.h
+++ b/include/linux/hid_bpf.h
@@ -138,6 +138,7 @@ struct hid_bpf_ops {
         * It has the following arguments:
         *
         * ``ctx``: The HID-BPF context as &struct hid_bpf_ctx
+        *
         * ``reportnum``: the report number, as in hid_hw_raw_request()
         *
         * ``rtype``: the report type (``HID_INPUT_REPORT``, ``HID_FEATURE_REPORT``,
@@ -165,16 +166,17 @@ struct hid_bpf_ops {
         * It has the following arguments:
         *
         * ``ctx``: The HID-BPF context as &struct hid_bpf_ctx
+        *
         * ``source``: a u64 referring to a uniq but identifiable source. If %0, the
-        *             kernel itself emitted that call. For hidraw, ``source`` is set
-        *             to the associated ``struct file *``.
+        * kernel itself emitted that call. For hidraw, ``source`` is set
+        * to the associated ``struct file *``.
         *
         * Return: %0 to keep processing the request by hid-core; any other value
         * stops hid-core from processing that event. A positive value should be
         * returned with the number of bytes written to the device; a negative error
         * code interrupts the processing of this call.
         */
-       int (*hid_hw_output_report)(struct hid_bpf_ctx *ctx, __u64 source);
+       int (*hid_hw_output_report)(struct hid_bpf_ctx *ctx, u64 source);
 
 
        /* private: do not show up in the docs */
@@ -203,9 +205,9 @@ int dispatch_hid_bpf_raw_requests(struct hid_device *hdev,
                                  unsigned char reportnum, __u8 *buf,
                                  u32 size, enum hid_report_type rtype,
                                  enum hid_class_request reqtype,
-                                 __u64 source, bool from_bpf);
+                                 u64 source, bool from_bpf);
 int dispatch_hid_bpf_output_report(struct hid_device *hdev, __u8 *buf, u32 size,
-                                  __u64 source, bool from_bpf);
+                                  u64 source, bool from_bpf);
 int hid_bpf_connect_device(struct hid_device *hdev);
 void hid_bpf_disconnect_device(struct hid_device *hdev);
 void hid_bpf_destroy_device(struct hid_device *hid);
@@ -221,7 +223,7 @@ static inline int dispatch_hid_bpf_raw_requests(struct hid_device *hdev,
                                                enum hid_class_request reqtype,
                                                u64 source, bool from_bpf) { return 0; }
 static inline int dispatch_hid_bpf_output_report(struct hid_device *hdev, __u8 *buf, u32 size,
-                                                __u64 source, bool from_bpf) { return 0; }
+                                                u64 source, bool from_bpf) { return 0; }
 static inline int hid_bpf_connect_device(struct hid_device *hdev) { return 0; }
 static inline void hid_bpf_disconnect_device(struct hid_device *hdev) {}
 static inline void hid_bpf_destroy_device(struct hid_device *hid) {}