Thomas Gleixner | 1a59d1b8 | 2019-05-27 08:55:05 +0200 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | */ |
| 17 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 18 | #include <linux/hid.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 19 | #include <linux/input.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 20 | #include <linux/slab.h> |
Paul Gortmaker | 8f86a2c | 2011-07-03 13:39:48 -0400 | [diff] [blame] | 21 | #include <linux/module.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 22 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 23 | #include "hid-ids.h" |
| 24 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 25 | static const signed short ff_rumble[] = { |
| 26 | FF_RUMBLE, |
| 27 | -1 |
| 28 | }; |
| 29 | |
| 30 | static const signed short ff_joystick[] = { |
| 31 | FF_CONSTANT, |
| 32 | -1 |
| 33 | }; |
| 34 | |
Jiri Kosina | 0f6f431 | 2009-05-15 15:46:44 +0200 | [diff] [blame] | 35 | #ifdef CONFIG_THRUSTMASTER_FF |
Jiri Kosina | 0f6f431 | 2009-05-15 15:46:44 +0200 | [diff] [blame] | 36 | |
| 37 | /* Usages for thrustmaster devices I know about */ |
| 38 | #define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb) |
| 39 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | struct tmff_device { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | struct hid_report *report; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 42 | struct hid_field *ff_field; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | }; |
| 44 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 45 | /* Changes values from 0 to 0xffff into values from minimum to maximum */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 46 | static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum) |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 47 | { |
| 48 | int ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 50 | ret = (in * (maximum - minimum) / 0xffff) + minimum; |
| 51 | if (ret < minimum) |
| 52 | return minimum; |
| 53 | if (ret > maximum) |
| 54 | return maximum; |
| 55 | return ret; |
| 56 | } |
| 57 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 58 | /* Changes values from -0x80 to 0x7f into values from minimum to maximum */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 59 | static inline int tmff_scale_s8(int in, int minimum, int maximum) |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 60 | { |
| 61 | int ret; |
| 62 | |
| 63 | ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum; |
| 64 | if (ret < minimum) |
| 65 | return minimum; |
| 66 | if (ret > maximum) |
| 67 | return maximum; |
| 68 | return ret; |
| 69 | } |
| 70 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 71 | static int tmff_play(struct input_dev *dev, void *data, |
| 72 | struct ff_effect *effect) |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 73 | { |
Dmitry Torokhov | e071298 | 2007-05-09 10:17:31 +0200 | [diff] [blame] | 74 | struct hid_device *hid = input_get_drvdata(dev); |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 75 | struct tmff_device *tmff = data; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 76 | struct hid_field *ff_field = tmff->ff_field; |
| 77 | int x, y; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 78 | int left, right; /* Rumbling */ |
| 79 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 80 | switch (effect->type) { |
| 81 | case FF_CONSTANT: |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 82 | x = tmff_scale_s8(effect->u.ramp.start_level, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 83 | ff_field->logical_minimum, |
| 84 | ff_field->logical_maximum); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 85 | y = tmff_scale_s8(effect->u.ramp.end_level, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 86 | ff_field->logical_minimum, |
| 87 | ff_field->logical_maximum); |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 88 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 89 | dbg_hid("(x, y)=(%04x, %04x)\n", x, y); |
| 90 | ff_field->value[0] = x; |
| 91 | ff_field->value[1] = y; |
Benjamin Tissoires | d8814272 | 2013-02-25 11:31:46 +0100 | [diff] [blame] | 92 | hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 93 | break; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 94 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 95 | case FF_RUMBLE: |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 96 | left = tmff_scale_u16(effect->u.rumble.weak_magnitude, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 97 | ff_field->logical_minimum, |
| 98 | ff_field->logical_maximum); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 99 | right = tmff_scale_u16(effect->u.rumble.strong_magnitude, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 100 | ff_field->logical_minimum, |
| 101 | ff_field->logical_maximum); |
| 102 | |
| 103 | dbg_hid("(left,right)=(%08x, %08x)\n", left, right); |
| 104 | ff_field->value[0] = left; |
| 105 | ff_field->value[1] = right; |
Benjamin Tissoires | d8814272 | 2013-02-25 11:31:46 +0100 | [diff] [blame] | 106 | hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 107 | break; |
| 108 | } |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 109 | return 0; |
| 110 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 112 | static int tmff_init(struct hid_device *hid, const signed short *ff_bits) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | { |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 114 | struct tmff_device *tmff; |
Li Zefan | 3ba5619 | 2007-11-14 11:31:05 +0100 | [diff] [blame] | 115 | struct hid_report *report; |
| 116 | struct list_head *report_list; |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 117 | struct hid_input *hidinput = list_entry(hid->inputs.next, |
| 118 | struct hid_input, list); |
Dmitry Torokhov | c5b7c7c | 2005-09-15 02:01:47 -0500 | [diff] [blame] | 119 | struct input_dev *input_dev = hidinput->input; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 120 | int error; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 121 | int i; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 123 | tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL); |
| 124 | if (!tmff) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | return -ENOMEM; |
| 126 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | /* Find the report to use */ |
Li Zefan | 3ba5619 | 2007-11-14 11:31:05 +0100 | [diff] [blame] | 128 | report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list; |
| 129 | list_for_each_entry(report, report_list, list) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | int fieldnum; |
| 131 | |
| 132 | for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) { |
| 133 | struct hid_field *field = report->field[fieldnum]; |
| 134 | |
| 135 | if (field->maxusage <= 0) |
| 136 | continue; |
| 137 | |
| 138 | switch (field->usage[0].hid) { |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 139 | case THRUSTMASTER_USAGE_FF: |
| 140 | if (field->report_count < 2) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 141 | hid_warn(hid, "ignoring FF field with report_count < 2\n"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | continue; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 143 | } |
| 144 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 145 | if (field->logical_maximum == |
| 146 | field->logical_minimum) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 147 | hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 148 | continue; |
| 149 | } |
| 150 | |
| 151 | if (tmff->report && tmff->report != report) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 152 | hid_warn(hid, "ignoring FF field in other report\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 153 | continue; |
| 154 | } |
| 155 | |
| 156 | if (tmff->ff_field && tmff->ff_field != field) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 157 | hid_warn(hid, "ignoring duplicate FF field\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 158 | continue; |
| 159 | } |
| 160 | |
| 161 | tmff->report = report; |
| 162 | tmff->ff_field = field; |
| 163 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 164 | for (i = 0; ff_bits[i] >= 0; i++) |
| 165 | set_bit(ff_bits[i], input_dev->ffbit); |
| 166 | |
| 167 | break; |
| 168 | |
| 169 | default: |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 170 | hid_warn(hid, "ignoring unknown output usage %08x\n", |
| 171 | field->usage[0].hid); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 172 | continue; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | } |
| 175 | } |
| 176 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 177 | if (!tmff->report) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 178 | hid_err(hid, "can't find FF field in output reports\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 179 | error = -ENODEV; |
| 180 | goto fail; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 181 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 183 | error = input_ff_create_memless(input_dev, tmff, tmff_play); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 184 | if (error) |
| 185 | goto fail; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 186 | |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 187 | hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | return 0; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 189 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 190 | fail: |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 191 | kfree(tmff); |
| 192 | return error; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | } |
Jiri Kosina | 0f6f431 | 2009-05-15 15:46:44 +0200 | [diff] [blame] | 194 | #else |
| 195 | static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits) |
| 196 | { |
| 197 | return 0; |
| 198 | } |
| 199 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 200 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 201 | static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id) |
| 202 | { |
| 203 | int ret; |
| 204 | |
| 205 | ret = hid_parse(hdev); |
| 206 | if (ret) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 207 | hid_err(hdev, "parse failed\n"); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 208 | goto err; |
| 209 | } |
| 210 | |
| 211 | ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF); |
| 212 | if (ret) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 213 | hid_err(hdev, "hw start failed\n"); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 214 | goto err; |
| 215 | } |
| 216 | |
| 217 | tmff_init(hdev, (void *)id->driver_data); |
| 218 | |
| 219 | return 0; |
| 220 | err: |
| 221 | return ret; |
| 222 | } |
| 223 | |
| 224 | static const struct hid_device_id tm_devices[] = { |
| 225 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300), |
| 226 | .driver_data = (unsigned long)ff_rumble }, |
Ruben Aos Garralda | 7a84b13 | 2009-06-29 09:41:29 +0200 | [diff] [blame] | 227 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */ |
| 228 | .driver_data = (unsigned long)ff_rumble }, |
| 229 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */ |
| 230 | .driver_data = (unsigned long)ff_rumble }, |
| 231 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 232 | .driver_data = (unsigned long)ff_rumble }, |
Viktor Chapliev | 1477edb | 2017-11-07 11:13:16 +0300 | [diff] [blame] | 233 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */ |
| 234 | .driver_data = (unsigned long)ff_joystick }, |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 235 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */ |
| 236 | .driver_data = (unsigned long)ff_rumble }, |
Markus Rathgeb | 3ee8f0a | 2010-03-13 17:29:43 +0100 | [diff] [blame] | 237 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */ |
| 238 | .driver_data = (unsigned long)ff_joystick }, |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 239 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */ |
| 240 | .driver_data = (unsigned long)ff_joystick }, |
Simon Wood | d65c376 | 2010-11-29 17:41:23 +0100 | [diff] [blame] | 241 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */ |
| 242 | .driver_data = (unsigned long)ff_joystick }, |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 243 | { } |
| 244 | }; |
| 245 | MODULE_DEVICE_TABLE(hid, tm_devices); |
| 246 | |
| 247 | static struct hid_driver tm_driver = { |
| 248 | .name = "thrustmaster", |
| 249 | .id_table = tm_devices, |
| 250 | .probe = tm_probe, |
| 251 | }; |
H Hartley Sweeten | f425458 | 2012-12-17 15:28:26 -0700 | [diff] [blame] | 252 | module_hid_driver(tm_driver); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 253 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 254 | MODULE_LICENSE("GPL"); |