1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* Copyright (c) 2022 Benjamin Tissoires 3 */ 4 5 #ifndef __HID_BPF_HELPERS_H 6 #define __HID_BPF_HELPERS_H 7 8 #include "vmlinux.h" 9 #include <bpf/bpf_helpers.h> 10 #include <linux/errno.h> 11 12 extern __u8 *hid_bpf_get_data(struct hid_bpf_ctx *ctx, 13 unsigned int offset, 14 const size_t __sz) __ksym; 15 extern struct hid_bpf_ctx *hid_bpf_allocate_context(unsigned int hid_id) __ksym; 16 extern void hid_bpf_release_context(struct hid_bpf_ctx *ctx) __ksym; 17 extern int hid_bpf_hw_request(struct hid_bpf_ctx *ctx, 18 __u8 *data, 19 size_t buf__sz, 20 enum hid_report_type type, 21 enum hid_class_request reqtype) __ksym; 22 extern int hid_bpf_hw_output_report(struct hid_bpf_ctx *ctx, 23 __u8 *buf, size_t buf__sz) __weak __ksym; 24 extern int hid_bpf_input_report(struct hid_bpf_ctx *ctx, 25 enum hid_report_type type, 26 __u8 *data, 27 size_t buf__sz) __weak __ksym; 28 extern int hid_bpf_try_input_report(struct hid_bpf_ctx *ctx, 29 enum hid_report_type type, 30 __u8 *data, 31 size_t buf__sz) __weak __ksym; 32 33 /* bpf_wq implementation */ 34 extern int bpf_wq_init(struct bpf_wq *wq, void *p__map, unsigned int flags) __weak __ksym; 35 extern int bpf_wq_start(struct bpf_wq *wq, unsigned int flags) __weak __ksym; 36 extern int bpf_wq_set_callback(struct bpf_wq *wq, 37 int (*callback_fn)(void *, int *, void *), 38 unsigned int flags) __weak __ksym; 39 40 #define HID_MAX_DESCRIPTOR_SIZE 4096 41 #define HID_IGNORE_EVENT -1 42 43 /* extracted from <linux/input.h> */ 44 #define BUS_ANY 0x00 45 #define BUS_PCI 0x01 46 #define BUS_ISAPNP 0x02 47 #define BUS_USB 0x03 48 #define BUS_HIL 0x04 49 #define BUS_BLUETOOTH 0x05 50 #define BUS_VIRTUAL 0x06 51 #define BUS_ISA 0x10 52 #define BUS_I8042 0x11 53 #define BUS_XTKBD 0x12 54 #define BUS_RS232 0x13 55 #define BUS_GAMEPORT 0x14 56 #define BUS_PARPORT 0x15 57 #define BUS_AMIGA 0x16 58 #define BUS_ADB 0x17 59 #define BUS_I2C 0x18 60 #define BUS_HOST 0x19 61 #define BUS_GSC 0x1A 62 #define BUS_ATARI 0x1B 63 #define BUS_SPI 0x1C 64 #define BUS_RMI 0x1D 65 #define BUS_CEC 0x1E 66 #define BUS_INTEL_ISHTP 0x1F 67 #define BUS_AMD_SFH 0x20 68 69 /* extracted from <linux/hid.h> */ 70 #define HID_GROUP_ANY 0x0000 71 #define HID_GROUP_GENERIC 0x0001 72 #define HID_GROUP_MULTITOUCH 0x0002 73 #define HID_GROUP_SENSOR_HUB 0x0003 74 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 75 #define HID_GROUP_RMI 0x0100 76 #define HID_GROUP_WACOM 0x0101 77 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102 78 #define HID_GROUP_STEAM 0x0103 79 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104 80 #define HID_GROUP_VIVALDI 0x0105 81 82 /* include/linux/mod_devicetable.h defines as (~0), but that gives us negative size arrays */ 83 #define HID_VID_ANY 0x0000 84 #define HID_PID_ANY 0x0000 85 86 #define BIT(n) (1UL << (n)) 87 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) 88 89 /* Helper macro to convert (foo, __LINE__) into foo134 so we can use __LINE__ for 90 * field/variable names 91 */ 92 #define COMBINE1(X, Y) X ## Y 93 #define COMBINE(X, Y) COMBINE1(X, Y) 94 95 /* Macro magic: 96 * __uint(foo, 123) creates a int (*foo)[1234] 97 * 98 * We use that macro to declare an anonymous struct with several 99 * fields, each is the declaration of an pointer to an array of size 100 * bus/group/vid/pid. (Because it's a pointer to such an array, actual storage 101 * would be sizeof(pointer) rather than sizeof(array). Not that we ever 102 * instantiate it anyway). 103 * 104 * This is only used for BTF introspection, we can later check "what size 105 * is the bus array" in the introspection data and thus extract the bus ID 106 * again. 107 * 108 * And we use the __LINE__ to give each of our structs a unique name so the 109 * BPF program writer doesn't have to. 110 * 111 * $ bpftool btf dump file target/bpf/HP_Elite_Presenter.bpf.o 112 * shows the inspection data, start by searching for .hid_bpf_config 113 * and working backwards from that (each entry references the type_id of the 114 * content). 115 */ 116 117 #define HID_DEVICE(b, g, ven, prod) \ 118 struct { \ 119 __uint(name, 0); \ 120 __uint(bus, (b)); \ 121 __uint(group, (g)); \ 122 __uint(vid, (ven)); \ 123 __uint(pid, (prod)); \ 124 } COMBINE(_entry, __LINE__) 125 126 /* Macro magic below is to make HID_BPF_CONFIG() look like a function call that 127 * we can pass multiple HID_DEVICE() invocations in. 128 * 129 * For up to 16 arguments, HID_BPF_CONFIG(one, two) resolves to 130 * 131 * union { 132 * HID_DEVICE(...); 133 * HID_DEVICE(...); 134 * } _device_ids SEC(".hid_bpf_config") 135 * 136 */ 137 138 /* Returns the number of macro arguments, this expands 139 * NARGS(a, b, c) to NTH_ARG(a, b, c, 15, 14, 13, .... 4, 3, 2, 1). 140 * NTH_ARG always returns the 16th argument which in our case is 3. 141 * 142 * If we want more than 16 values _COUNTDOWN and _NTH_ARG both need to be 143 * updated. 144 */ 145 #define _NARGS(...) _NARGS1(__VA_ARGS__, _COUNTDOWN) 146 #define _NARGS1(...) _NTH_ARG(__VA_ARGS__) 147 148 /* Add to this if we need more than 16 args */ 149 #define _COUNTDOWN \ 150 15, 14, 13, 12, 11, 10, 9, 8, \ 151 7, 6, 5, 4, 3, 2, 1, 0 152 153 /* Return the 16 argument passed in. See _NARGS above for usage. Note this is 154 * 1-indexed. 155 */ 156 #define _NTH_ARG( \ 157 _1, _2, _3, _4, _5, _6, _7, _8, \ 158 _9, _10, _11, _12, _13, _14, _15,\ 159 N, ...) N 160 161 /* Turns EXPAND(_ARG, a, b, c) into _ARG3(a, b, c) */ 162 #define _EXPAND(func, ...) COMBINE(func, _NARGS(__VA_ARGS__)) (__VA_ARGS__) 163 164 /* And now define all the ARG macros for each number of args we want to accept */ 165 #define _ARG1(_1) _1; 166 #define _ARG2(_1, _2) _1; _2; 167 #define _ARG3(_1, _2, _3) _1; _2; _3; 168 #define _ARG4(_1, _2, _3, _4) _1; _2; _3; _4; 169 #define _ARG5(_1, _2, _3, _4, _5) _1; _2; _3; _4; _5; 170 #define _ARG6(_1, _2, _3, _4, _5, _6) _1; _2; _3; _4; _5; _6; 171 #define _ARG7(_1, _2, _3, _4, _5, _6, _7) _1; _2; _3; _4; _5; _6; _7; 172 #define _ARG8(_1, _2, _3, _4, _5, _6, _7, _8) _1; _2; _3; _4; _5; _6; _7; _8; 173 #define _ARG9(_1, _2, _3, _4, _5, _6, _7, _8, _9) _1; _2; _3; _4; _5; _6; _7; _8; _9; 174 #define _ARG10(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; 175 #define _ARG11(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; _b; 176 #define _ARG12(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b, _c) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; _b; _c; 177 #define _ARG13(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b, _c, _d) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; _b; _c; _d; 178 #define _ARG14(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b, _c, _d, _e) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; _b; _c; _d; _e; 179 #define _ARG15(_1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b, _c, _d, _e, _f) _1; _2; _3; _4; _5; _6; _7; _8; _9; _a; _b; _c; _d; _e; _f; 180 181 182 #define HID_BPF_CONFIG(...) union { \ 183 _EXPAND(_ARG, __VA_ARGS__) \ 184 } _device_ids SEC(".hid_bpf_config") 185 186 #endif /* __HID_BPF_HELPERS_H */ 187