|
| 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 | + */ |
| 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 | + */ |
| 56 | +static int universal_pidff_probe(struct hid_device *hdev, |
| 57 | + const struct hid_device_id *id) |
| 58 | +{ |
| 59 | + int i, error; |
| 60 | + error = hid_parse(hdev); |
| 61 | + if (error) { |
| 62 | + hid_err(hdev, "HID parse failed\n"); |
| 63 | + goto err; |
| 64 | + } |
| 65 | + |
| 66 | + error = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF); |
| 67 | + if (error) { |
| 68 | + hid_err(hdev, "HID hw start failed\n"); |
| 69 | + goto err; |
| 70 | + } |
| 71 | + |
| 72 | + /* Check if device contains PID usage page */ |
| 73 | + error = 1; |
| 74 | + for (i = 0; i < hdev->collection_size; i++) |
| 75 | + if ((hdev->collection[i].usage & HID_USAGE_PAGE) == HID_UP_PID) { |
| 76 | + error = 0; |
| 77 | + hid_dbg(hdev, "PID usage page found\n"); |
| 78 | + break; |
| 79 | + } |
| 80 | + |
| 81 | + /* |
| 82 | + * Do not fail as this might be the second "device" |
| 83 | + * just for additional buttons/axes. Exit cleanly if force |
| 84 | + * feedback usage page wasn't found (included devices were |
| 85 | + * tested and confirmed to be USB PID after all). |
| 86 | + */ |
| 87 | + if (error) { |
| 88 | + hid_dbg(hdev, "PID usage page not found in the descriptor\n"); |
| 89 | + return 0; |
| 90 | + } |
| 91 | + |
| 92 | + /* Check if HID_PID support is enabled */ |
| 93 | + int (*init_function)(struct hid_device *, u32); |
| 94 | + init_function = hid_pidff_init_with_quirks; |
| 95 | + |
| 96 | + if (!init_function) { |
| 97 | + hid_warn(hdev, "HID_PID support not enabled!\n"); |
| 98 | + return 0; |
| 99 | + } |
| 100 | + |
| 101 | + error = init_function(hdev, id->driver_data); |
| 102 | + if (error) { |
| 103 | + hid_warn(hdev, "Error initialising force feedback\n"); |
| 104 | + goto err; |
| 105 | + } |
| 106 | + |
| 107 | + hid_info(hdev, "Universal pidff driver loaded successfully!"); |
| 108 | + |
| 109 | + return 0; |
| 110 | +err: |
| 111 | + return error; |
| 112 | +} |
| 113 | + |
| 114 | +static int universal_pidff_input_configured(struct hid_device *hdev, |
| 115 | + struct hid_input *hidinput) |
| 116 | +{ |
| 117 | + int axis; |
| 118 | + struct input_dev *input = hidinput->input; |
| 119 | + |
| 120 | + if (!input->absinfo) |
| 121 | + return 0; |
| 122 | + |
| 123 | + /* Decrease fuzz and deadzone on available axes */ |
| 124 | + for (axis = ABS_X; axis <= ABS_BRAKE; axis++) { |
| 125 | + if (!test_bit(axis, input->absbit)) |
| 126 | + continue; |
| 127 | + |
| 128 | + input_set_abs_params(input, axis, |
| 129 | + input->absinfo[axis].minimum, |
| 130 | + input->absinfo[axis].maximum, |
| 131 | + axis == ABS_X ? 0 : 8, 0); |
| 132 | + } |
| 133 | + |
| 134 | + /* Remove fuzz and deadzone from the second joystick axis */ |
| 135 | + if (hdev->vendor == USB_VENDOR_ID_FFBEAST && |
| 136 | + hdev->product == USB_DEVICE_ID_FFBEAST_JOYSTICK) |
| 137 | + input_set_abs_params(input, ABS_Y, |
| 138 | + input->absinfo[ABS_Y].minimum, |
| 139 | + input->absinfo[ABS_Y].maximum, 0, 0); |
| 140 | + |
| 141 | + return 0; |
| 142 | +} |
| 143 | + |
| 144 | +static const struct hid_device_id universal_pidff_devices[] = { |
| 145 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3), |
| 146 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 147 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3_2), |
| 148 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 149 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5), |
| 150 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 151 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5_2), |
| 152 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 153 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9), |
| 154 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 155 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9_2), |
| 156 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 157 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12), |
| 158 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 159 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12_2), |
| 160 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 161 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16_R21), |
| 162 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 163 | + { HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16_R21_2), |
| 164 | + .driver_data = HID_PIDFF_QUIRK_FIX_WHEEL_DIRECTION }, |
| 165 | + { HID_USB_DEVICE(USB_VENDOR_ID_CAMMUS, USB_DEVICE_ID_CAMMUS_C5) }, |
| 166 | + { HID_USB_DEVICE(USB_VENDOR_ID_CAMMUS, USB_DEVICE_ID_CAMMUS_C12) }, |
| 167 | + { HID_USB_DEVICE(USB_VENDOR_ID_VRS, USB_DEVICE_ID_VRS_DFP), |
| 168 | + .driver_data = HID_PIDFF_QUIRK_PERMISSIVE_CONTROL }, |
| 169 | + { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_JOYSTICK), }, |
| 170 | + { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_RUDDER), }, |
| 171 | + { HID_USB_DEVICE(USB_VENDOR_ID_FFBEAST, USB_DEVICE_ID_FFBEAST_WHEEL) }, |
| 172 | + { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V10), |
| 173 | + .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY }, |
| 174 | + { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12), |
| 175 | + .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY }, |
| 176 | + { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12_LITE), |
| 177 | + .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY }, |
| 178 | + { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_ID_PXN_V12_LITE_2), |
| 179 | + .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY }, |
| 180 | + { HID_USB_DEVICE(USB_VENDOR_ID_LITE_STAR, USB_DEVICE_LITE_STAR_GT987_FF), |
| 181 | + .driver_data = HID_PIDFF_QUIRK_PERIODIC_SINE_ONLY }, |
| 182 | + { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_INVICTA) }, |
| 183 | + { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_FORTE) }, |
| 184 | + { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_LA_PRIMA) }, |
| 185 | + { HID_USB_DEVICE(USB_VENDOR_ID_ASETEK, USB_DEVICE_ID_ASETEK_TONY_KANAAN) }, |
| 186 | + { } |
| 187 | +}; |
| 188 | +MODULE_DEVICE_TABLE(hid, universal_pidff_devices); |
| 189 | + |
| 190 | +static struct hid_driver universal_pidff = { |
| 191 | + .name = "hid-universal-pidff", |
| 192 | + .id_table = universal_pidff_devices, |
| 193 | + .input_mapping = universal_pidff_input_mapping, |
| 194 | + .probe = universal_pidff_probe, |
| 195 | + .input_configured = universal_pidff_input_configured |
| 196 | +}; |
| 197 | +module_hid_driver(universal_pidff); |
| 198 | + |
| 199 | +MODULE_DESCRIPTION("Universal driver for USB PID Force Feedback devices"); |
| 200 | +MODULE_LICENSE("GPL"); |
| 201 | +MODULE_AUTHOR("Oleg Makarenko <oleg@makarenk.ooo>"); |
| 202 | +MODULE_AUTHOR("Tomasz Pakuła <tomasz.pakula.oficjalny@gmail.com>"); |
0 commit comments