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 = list_entry(hid->inputs.next, 128 struct hid_input, list); 129 struct input_dev *input_dev = hidinput->input; 130 int error; 131 int i; 132 133 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL); 134 if (!tmff) 135 return -ENOMEM; 136 137 /* Find the report to use */ 138 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list; 139 list_for_each_entry(report, report_list, list) { 140 int fieldnum; 141 142 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) { 143 struct hid_field *field = report->field[fieldnum]; 144 145 if (field->maxusage <= 0) 146 continue; 147 148 switch (field->usage[0].hid) { 149 case THRUSTMASTER_USAGE_FF: 150 if (field->report_count < 2) { 151 hid_warn(hid, "ignoring FF field with report_count < 2\n"); 152 continue; 153 } 154 155 if (field->logical_maximum == 156 field->logical_minimum) { 157 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n"); 158 continue; 159 } 160 161 if (tmff->report && tmff->report != report) { 162 hid_warn(hid, "ignoring FF field in other report\n"); 163 continue; 164 } 165 166 if (tmff->ff_field && tmff->ff_field != field) { 167 hid_warn(hid, "ignoring duplicate FF field\n"); 168 continue; 169 } 170 171 tmff->report = report; 172 tmff->ff_field = field; 173 174 for (i = 0; ff_bits[i] >= 0; i++) 175 set_bit(ff_bits[i], input_dev->ffbit); 176 177 break; 178 179 default: 180 hid_warn(hid, "ignoring unknown output usage %08x\n", 181 field->usage[0].hid); 182 continue; 183 } 184 } 185 } 186 187 if (!tmff->report) { 188 hid_err(hid, "can't find FF field in output reports\n"); 189 error = -ENODEV; 190 goto fail; 191 } 192 193 error = input_ff_create_memless(input_dev, tmff, tmff_play); 194 if (error) 195 goto fail; 196 197 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n"); 198 return 0; 199 200 fail: 201 kfree(tmff); 202 return error; 203 } 204 #else 205 static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits) 206 { 207 return 0; 208 } 209 #endif 210 211 static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id) 212 { 213 int ret; 214 215 ret = hid_parse(hdev); 216 if (ret) { 217 hid_err(hdev, "parse failed\n"); 218 goto err; 219 } 220 221 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF); 222 if (ret) { 223 hid_err(hdev, "hw start failed\n"); 224 goto err; 225 } 226 227 tmff_init(hdev, (void *)id->driver_data); 228 229 return 0; 230 err: 231 return ret; 232 } 233 234 static const struct hid_device_id tm_devices[] = { 235 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300), 236 .driver_data = (unsigned long)ff_rumble }, 237 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */ 238 .driver_data = (unsigned long)ff_rumble }, 239 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, THRUSTMASTER_DEVICE_ID_2_IN_1_DT), /* Dual Trigger 2-in-1 */ 240 .driver_data = (unsigned long)ff_rumble }, 241 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */ 242 .driver_data = (unsigned long)ff_rumble }, 243 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */ 244 .driver_data = (unsigned long)ff_rumble }, 245 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */ 246 .driver_data = (unsigned long)ff_joystick }, 247 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */ 248 .driver_data = (unsigned long)ff_rumble }, 249 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */ 250 .driver_data = (unsigned long)ff_joystick }, 251 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */ 252 .driver_data = (unsigned long)ff_joystick }, 253 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */ 254 .driver_data = (unsigned long)ff_joystick }, 255 { } 256 }; 257 MODULE_DEVICE_TABLE(hid, tm_devices); 258 259 static struct hid_driver tm_driver = { 260 .name = "thrustmaster", 261 .id_table = tm_devices, 262 .probe = tm_probe, 263 }; 264 module_hid_driver(tm_driver); 265 266 MODULE_LICENSE("GPL"); 267