1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * HID UNIVERSAL PIDFF
4 * hid-pidff wrapper for PID-enabled devices
5 * Handles device reports, quirks and extends usable button range
6 *
7 * Copyright (c) 2024, 2025 Oleg Makarenko
8 * Copyright (c) 2024, 2025 Tomasz Pakuła
9 */
10
11 #include <linux/device.h>
12 #include <linux/hid.h>
13 #include <linux/module.h>
14 #include <linux/input-event-codes.h>
15 #include "hid-ids.h"
16 #include "usbhid/hid-pidff.h"
17
18 #define JOY_RANGE (BTN_DEAD - BTN_JOYSTICK + 1)
19
20 /*
21 * Map buttons manually to extend the default joystick button limit
22 */
universal_pidff_input_mapping(struct hid_device * hdev,struct hid_input * hi,struct hid_field * field,struct hid_usage * usage,unsigned long ** bit,int * max)23 static int universal_pidff_input_mapping(struct hid_device *hdev,
24 struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
25 unsigned long **bit, int *max)
26 {
27 if ((usage->hid & HID_USAGE_PAGE) != HID_UP_BUTTON)
28 return 0;
29
30 if (field->application != HID_GD_JOYSTICK)
31 return 0;
32
33 int button = ((usage->hid - 1) & HID_USAGE);
34 int code = button + BTN_JOYSTICK;
35
36 /* Detect the end of JOYSTICK buttons range */
37 if (code > BTN_DEAD)
38 code = button + KEY_NEXT_FAVORITE - JOY_RANGE;
39
40 /*
41 * Map overflowing buttons to KEY_RESERVED to not ignore
42 * them and let them still trigger MSC_SCAN
43 */
44 if (code > KEY_MAX)
45 code = KEY_RESERVED;
46
47 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
48 hid_dbg(hdev, "Button %d: usage %d", button, code);
49 return 1;
50 }
51
52 /*
53 * Check if the device is PID and initialize it
54 * Add quirks after initialisation
55 */
universal_pidff_probe(struct hid_device * hdev,const struct hid_device_id * id)56 static int universal_pidff_probe(struct hid_device *hdev,
57 const struct hid_device_id *id)
58 {
59 int i, error;
60
61 error = hid_parse(hdev);
62 if (error) {
63 hid_err(hdev, "HID parse failed\n");
64 goto err;
65 }
66
67 error = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
68 if (error) {
69 hid_err(hdev, "HID hw start failed\n");
70 goto err;
71 }
72
73 /* Check if device contains PID usage page */
74 error = 1;
75 for (i = 0; i < hdev->collection_size; i++)
76 if ((hdev->collection[i].usage & HID_USAGE_PAGE) == HID_UP_PID) {
77 error = 0;
78 hid_dbg(hdev, "PID usage page found\n");
79 break;
80 }
81
82 /*
83 * Do not fail as this might be the second "device"
84 * just for additional buttons/axes. Exit cleanly if force
85 * feedback usage page wasn't found (included devices were
86 * tested and confirmed to be USB PID after all).
87 */
88 if (error) {
89 hid_dbg(hdev, "PID usage page not found in the descriptor\n");
90 return 0;
91 }
92
93 /* Check if HID_PID support is enabled */
94 int (*init_function)(struct hid_device *, u32);
95
96 init_function = hid_pidff_init_with_quirks;
97 if (!init_function) {
98 hid_warn(hdev, "HID_PID support not enabled!\n");
99 return 0;
100 }
101
102 error = init_function(hdev, id->driver_data);
103 if (error) {
104 hid_warn(hdev, "Error initialising force feedback\n");
105 goto err;
106 }
107
108 hid_info(hdev, "Universal pidff driver loaded successfully!");
109
110 return 0;
111 err:
112 return error;
113 }
114
universal_pidff_input_configured(struct hid_device * hdev,struct hid_input * hidinput)115 static int universal_pidff_input_configured(struct hid_device *hdev,
116 struct hid_input *hidinput)
117 {
118 int axis;
119 struct input_dev *input = hidinput->input;
120
121 if (!input->absinfo)
122 return 0;
123
124 /* Decrease fuzz and deadzone on available axes */
125 for (axis = ABS_X; axis <= ABS_BRAKE; axis++) {
126 if (!test_bit(axis, input->absbit))
127 continue;
128
129 input_set_abs_params(input, axis,
130 input->absinfo[axis].minimum,
131 input->absinfo[axis].maximum,
132 axis == ABS_X ? 0 : 8, 0);
133 }
134
135 /* Remove fuzz and deadzone from the second joystick axis */
136 if (hdev->vendor == USB_VENDOR_ID_FFBEAST &&
137 hdev->product == USB_DEVICE_ID_FFBEAST_JOYSTICK)
138 input_set_abs_params(input, ABS_Y,
139 input->absinfo[ABS_Y].minimum,
140 input->absinfo[ABS_Y].maximum, 0, 0);
141
142 return 0;
143 }
144
145 static const struct hid_device_id universal_pidff_devices[] = {
146 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3),
147 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
148 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3_2),
149 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
150 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5),
151 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
152 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5_2),
153 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
154 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9),
155 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
156 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9_2),
157 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
158 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12),
159 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
160 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12_2),
161 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
162 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16_R21),
163 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
164 { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16_R21_2),
165 .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
166 { HID_USB_DEVICE(USB_VENDOR_ID_CAMMUS, USB_DEVICE_ID_CAMMUS_C5) },
167 { HID_USB_DEVICE(USB_VENDOR_ID_CAMMUS, USB_DEVICE_ID_CAMMUS_C12) },
168 { HID_USB_DEVICE(USB_VENDOR_ID_VRS, USB_DEVICE_ID_VRS_DFP),
169 .driver_data = HID_PIDFF_QUIRK_PERMISSIVE_CONTROL },
170 { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_JOYSTICK), },
171 { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_RUDDER), },
172 { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_WHEEL) },
173 { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V10),
174 .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY },
175 { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12),
176 .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY },
177 { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12_LITE),
178 .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY },
179 { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12_LITE_2),
180 .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY },
181 { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_LITE_STAR_GT987),
182 .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY },
183 { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_INVICTA) },
184 { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_FORTE) },
185 { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_LA_PRIMA) },
186 { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_TONY_KANAAN) },
187 { }
188 };
189 MODULE_DEVICE_TABLE(hid, universal_pidff_devices);
190
191 static struct hid_driver universal_pidff = {
192 .name = "hid-universal-pidff",
193 .id_table = universal_pidff_devices,
194 .input_mapping = universal_pidff_input_mapping,
195 .probe = universal_pidff_probe,
196 .input_configured = universal_pidff_input_configured
197 };
198 module_hid_driver(universal_pidff);
199
200 MODULE_DESCRIPTION("Universal driver for USB PID Force Feedback devices");
201 MODULE_LICENSE("GPL");
202 MODULE_AUTHOR("Oleg Makarenko <oleg@makarenk.ooo>");
203 MODULE_AUTHOR("Tomasz Pakuła <tomasz.pakula.oficjalny@gmail.com>");
204