1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Force feedback support for various HID compliant devices by ThrustMaster: 4 * ThrustMaster FireStorm Dual Power 2 5 * and possibly others whose device ids haven't been added. 6 * 7 * Modified to support ThrustMaster devices by Zinx Verituse 8 * on 2003-01-25 from the Logitech force feedback driver, 9 * which is by Johann Deneux. 10 * 11 * Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org> 12 * Copyright (c) 2002 Johann Deneux 13 */ 14 15 /* 16 */ 17 18 #include <linux/hid.h> 19 #include <linux/input.h> 20 #include <linux/slab.h> 21 #include <linux/module.h> 22 23 #include "hid-ids.h" 24 25 #define THRUSTMASTER_DEVICE_ID_2_IN_1_DT 0xb320 26 27 static const signed short ff_rumble[] = { 28 FF_RUMBLE, 29 -1 30 }; 31 32 static const signed short ff_joystick[] = { 33 FF_CONSTANT, 34 -1 35 }; 36 37 #ifdef CONFIG_THRUSTMASTER_FF 38 39 /* Usages for thrustmaster devices I know about */ 40 #define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb) 41 42 struct tmff_device { 43 struct hid_report *report; 44 struct hid_field *ff_field; 45 }; 46 47 /* Changes values from 0 to 0xffff into values from minimum to maximum */ 48 static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum) 49 { 50 int ret; 51 52 ret = (in * (maximum - minimum) / 0xffff) + minimum; 53 if (ret < minimum) 54 return minimum; 55 if (ret > maximum) 56 return maximum; 57 return ret; 58 } 59 60 /* Changes values from -0x80 to 0x7f into values from minimum to maximum */ 61 static inline int tmff_scale_s8(int in, int minimum, int maximum) 62 { 63 int ret; 64 65 ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum; 66 if (ret < minimum) 67 return minimum; 68 if (ret > maximum) 69 return maximum; 70 return ret; 71 } 72 73 static int tmff_play(struct input_dev *dev, void *data, 74 struct ff_effect *effect) 75 { 76 struct hid_device *hid = input_get_drvdata(dev); 77 struct tmff_device *tmff = data; 78 struct hid_field *ff_field = tmff->ff_field; 79 int x, y; 80 int left, right; /* Rumbling */ 81 int motor_swap; 82 83 switch (effect->type) { 84 case FF_CONSTANT: 85 x = tmff_scale_s8(effect->u.ramp.start_level, 86 ff_field->logical_minimum, 87 ff_field->logical_maximum); 88 y = tmff_scale_s8(effect->u.ramp.end_level, 89 ff_field->logical_minimum, 90 ff_field->logical_maximum); 91 92 dbg_hid("(x, y)=(%04x, %04x)\n", x, y); 93 ff_field->value[0] = x; 94 ff_field->value[1] = y; 95 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT); 96 break; 97 98 case FF_RUMBLE: 99 left = tmff_scale_u16(effect->u.rumble.weak_magnitude, 100 ff_field->logical_minimum, 101 ff_field->logical_maximum); 102 right = tmff_scale_u16(effect->u.rumble.strong_magnitude, 103 ff_field->logical_minimum, 104 ff_field->logical_maximum); 105 106 /* 2-in-1 strong motor is left */ 107 if (hid->product == THRUSTMASTER_DEVICE_ID_2_IN_1_DT) { 108 motor_swap = left; 109 left = right; 110 right = motor_swap; 111 } 112 113 dbg_hid("(left,right)=(%08x, %08x)\n", left, right); 114 ff_field->value[0] = left; 115 ff_field->value[1] = right; 116 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT); 117 break; 118 } 119 return 0; 120 } 121 122 static int tmff_init(struct hid_device *hid, const signed short *ff_bits) 123 { 124 struct tmff_device *tmff; 125 struct hid_report *report; 126 struct list_head *report_list; 127 struct hid_input *hidinput; 128 struct input_dev *input_dev; 129 int error; 130 int i; 131 132 if (list_empty(&hid->inputs)) { 133 hid_err(hid, "no inputs found\n"); 134 return -ENODEV; 135 } 136 hidinput = list_entry(hid->inputs.next, struct hid_input, list); 137 input_dev = hidinput->input; 138 139 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL); 140 if (!tmff) 141 return -ENOMEM; 142 143 /* Find the report to use */ 144 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list; 145 list_for_each_entry(report, report_list, list) { 146 int fieldnum; 147 148 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) { 149 struct hid_field *field = report->field[fieldnum]; 150 151 if (field->maxusage <= 0) 152 continue; 153 154 switch (field->usage[0].hid) { 155 case THRUSTMASTER_USAGE_FF: 156 if (field->report_count < 2) { 157 hid_warn(hid, "ignoring FF field with report_count < 2\n"); 158 continue; 159 } 160 161 if (field->logical_maximum == 162 field->logical_minimum) { 163 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n"); 164 continue; 165 } 166 167 if (tmff->report && tmff->report != report) { 168 hid_warn(hid, "ignoring FF field in other report\n"); 169 continue; 170 } 171 172 if (tmff->ff_field && tmff->ff_field != field) { 173 hid_warn(hid, "ignoring duplicate FF field\n"); 174 continue; 175 } 176 177 tmff->report = report; 178 tmff->ff_field = field; 179 180 for (i = 0; ff_bits[i] >= 0; i++) 181 set_bit(ff_bits[i], input_dev->ffbit); 182 183 break; 184 185 default: 186 hid_warn(hid, "ignoring unknown output usage %08x\n", 187 field->usage[0].hid); 188 continue; 189 } 190 } 191 } 192 193 if (!tmff->report) { 194 hid_err(hid, "can't find FF field in output reports\n"); 195 error = -ENODEV; 196 goto fail; 197 } 198 199 error = input_ff_create_memless(input_dev, tmff, tmff_play); 200 if (error) 201 goto fail; 202 203 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n"); 204 return 0; 205 206 fail: 207 kfree(tmff); 208 return error; 209 } 210 #else 211 static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits) 212 { 213 return 0; 214 } 215 #endif 216 217 static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id) 218 { 219 int ret; 220 221 ret = hid_parse(hdev); 222 if (ret) { 223 hid_err(hdev, "parse failed\n"); 224 goto err; 225 } 226 227 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF); 228 if (ret) { 229 hid_err(hdev, "hw start failed\n"); 230 goto err; 231 } 232 233 tmff_init(hdev, (void *)id->driver_data); 234 235 return 0; 236 err: 237 return ret; 238 } 239 240 static const struct hid_device_id tm_devices[] = { 241 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300), 242 .driver_data = (unsigned long)ff_rumble }, 243 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */ 244 .driver_data = (unsigned long)ff_rumble }, 245 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, THRUSTMASTER_DEVICE_ID_2_IN_1_DT), /* Dual Trigger 2-in-1 */ 246 .driver_data = (unsigned long)ff_rumble }, 247 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */ 248 .driver_data = (unsigned long)ff_rumble }, 249 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */ 250 .driver_data = (unsigned long)ff_rumble }, 251 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */ 252 .driver_data = (unsigned long)ff_joystick }, 253 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */ 254 .driver_data = (unsigned long)ff_rumble }, 255 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */ 256 .driver_data = (unsigned long)ff_joystick }, 257 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */ 258 .driver_data = (unsigned long)ff_joystick }, 259 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */ 260 .driver_data = (unsigned long)ff_joystick }, 261 { } 262 }; 263 MODULE_DEVICE_TABLE(hid, tm_devices); 264 265 static struct hid_driver tm_driver = { 266 .name = "thrustmaster", 267 .id_table = tm_devices, 268 .probe = tm_probe, 269 }; 270 module_hid_driver(tm_driver); 271 272 MODULE_LICENSE("GPL"); 273