blob: e12f2588ddebb028712ea212876154f50a1c7830 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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 Torvalds1da177e2005-04-16 15:20:36 -070016 */
17
Jiri Slaby10e41a72008-09-18 12:23:31 +020018#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/input.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Paul Gortmaker8f86a2c2011-07-03 13:39:48 -040021#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Jiri Slaby10e41a72008-09-18 12:23:31 +020023#include "hid-ids.h"
24
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020025static const signed short ff_rumble[] = {
26 FF_RUMBLE,
27 -1
28};
29
30static const signed short ff_joystick[] = {
31 FF_CONSTANT,
32 -1
33};
34
Jiri Kosina0f6f4312009-05-15 15:46:44 +020035#ifdef CONFIG_THRUSTMASTER_FF
Jiri Kosina0f6f4312009-05-15 15:46:44 +020036
37/* Usages for thrustmaster devices I know about */
38#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb)
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040struct tmff_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct hid_report *report;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020042 struct hid_field *ff_field;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043};
44
Anssi Hannuladc76c912006-07-19 01:40:55 -040045/* Changes values from 0 to 0xffff into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020046static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
Anssi Hannuladc76c912006-07-19 01:40:55 -040047{
48 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Anssi Hannuladc76c912006-07-19 01:40:55 -040050 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 Torokhovb27c9592007-07-30 14:56:26 +020058/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020059static inline int tmff_scale_s8(int in, int minimum, int maximum)
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020060{
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 Slaby10e41a72008-09-18 12:23:31 +020071static int tmff_play(struct input_dev *dev, void *data,
72 struct ff_effect *effect)
Anssi Hannuladc76c912006-07-19 01:40:55 -040073{
Dmitry Torokhove0712982007-05-09 10:17:31 +020074 struct hid_device *hid = input_get_drvdata(dev);
Anssi Hannuladc76c912006-07-19 01:40:55 -040075 struct tmff_device *tmff = data;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020076 struct hid_field *ff_field = tmff->ff_field;
77 int x, y;
Anssi Hannuladc76c912006-07-19 01:40:55 -040078 int left, right; /* Rumbling */
79
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020080 switch (effect->type) {
81 case FF_CONSTANT:
Jiri Slaby10e41a72008-09-18 12:23:31 +020082 x = tmff_scale_s8(effect->u.ramp.start_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020083 ff_field->logical_minimum,
84 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +020085 y = tmff_scale_s8(effect->u.ramp.end_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020086 ff_field->logical_minimum,
87 ff_field->logical_maximum);
Anssi Hannuladc76c912006-07-19 01:40:55 -040088
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020089 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
90 ff_field->value[0] = x;
91 ff_field->value[1] = y;
Benjamin Tissoiresd88142722013-02-25 11:31:46 +010092 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020093 break;
Anssi Hannuladc76c912006-07-19 01:40:55 -040094
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020095 case FF_RUMBLE:
Jiri Slaby10e41a72008-09-18 12:23:31 +020096 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020097 ff_field->logical_minimum,
98 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +020099 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200100 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 Tissoiresd88142722013-02-25 11:31:46 +0100106 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200107 break;
108 }
Anssi Hannuladc76c912006-07-19 01:40:55 -0400109 return 0;
110}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Jiri Slaby10e41a72008-09-18 12:23:31 +0200112static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
Anssi Hannuladc76c912006-07-19 01:40:55 -0400114 struct tmff_device *tmff;
Li Zefan3ba56192007-11-14 11:31:05 +0100115 struct hid_report *report;
116 struct list_head *report_list;
Jiri Slaby10e41a72008-09-18 12:23:31 +0200117 struct hid_input *hidinput = list_entry(hid->inputs.next,
118 struct hid_input, list);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500119 struct input_dev *input_dev = hidinput->input;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400120 int error;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200121 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Anssi Hannuladc76c912006-07-19 01:40:55 -0400123 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
124 if (!tmff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 return -ENOMEM;
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 /* Find the report to use */
Li Zefan3ba56192007-11-14 11:31:05 +0100128 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
129 list_for_each_entry(report, report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 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 Torokhovb27c9592007-07-30 14:56:26 +0200139 case THRUSTMASTER_USAGE_FF:
140 if (field->report_count < 2) {
Joe Perches4291ee32010-12-09 19:29:03 -0800141 hid_warn(hid, "ignoring FF field with report_count < 2\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 continue;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200143 }
144
Jiri Slaby10e41a72008-09-18 12:23:31 +0200145 if (field->logical_maximum ==
146 field->logical_minimum) {
Joe Perches4291ee32010-12-09 19:29:03 -0800147 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200148 continue;
149 }
150
151 if (tmff->report && tmff->report != report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800152 hid_warn(hid, "ignoring FF field in other report\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200153 continue;
154 }
155
156 if (tmff->ff_field && tmff->ff_field != field) {
Joe Perches4291ee32010-12-09 19:29:03 -0800157 hid_warn(hid, "ignoring duplicate FF field\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200158 continue;
159 }
160
161 tmff->report = report;
162 tmff->ff_field = field;
163
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200164 for (i = 0; ff_bits[i] >= 0; i++)
165 set_bit(ff_bits[i], input_dev->ffbit);
166
167 break;
168
169 default:
Joe Perches4291ee32010-12-09 19:29:03 -0800170 hid_warn(hid, "ignoring unknown output usage %08x\n",
171 field->usage[0].hid);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200172 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 }
175 }
176
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200177 if (!tmff->report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800178 hid_err(hid, "can't find FF field in output reports\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200179 error = -ENODEV;
180 goto fail;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400181 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Jiri Slaby10e41a72008-09-18 12:23:31 +0200183 error = input_ff_create_memless(input_dev, tmff, tmff_play);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200184 if (error)
185 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Joe Perches4291ee32010-12-09 19:29:03 -0800187 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 return 0;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200189
Jiri Slaby10e41a72008-09-18 12:23:31 +0200190fail:
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200191 kfree(tmff);
192 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200194#else
195static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
196{
197 return 0;
198}
199#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Jiri Slaby10e41a72008-09-18 12:23:31 +0200201static 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 Perches4291ee32010-12-09 19:29:03 -0800207 hid_err(hdev, "parse failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200208 goto err;
209 }
210
211 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
212 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800213 hid_err(hdev, "hw start failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200214 goto err;
215 }
216
217 tmff_init(hdev, (void *)id->driver_data);
218
219 return 0;
220err:
221 return ret;
222}
223
224static 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 Garralda7a84b132009-06-29 09:41:29 +0200227 { 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 Slaby10e41a72008-09-18 12:23:31 +0200232 .driver_data = (unsigned long)ff_rumble },
Viktor Chapliev1477edb2017-11-07 11:13:16 +0300233 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */
234 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200235 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
236 .driver_data = (unsigned long)ff_rumble },
Markus Rathgeb3ee8f0a2010-03-13 17:29:43 +0100237 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */
238 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200239 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
240 .driver_data = (unsigned long)ff_joystick },
Simon Woodd65c3762010-11-29 17:41:23 +0100241 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */
242 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200243 { }
244};
245MODULE_DEVICE_TABLE(hid, tm_devices);
246
247static struct hid_driver tm_driver = {
248 .name = "thrustmaster",
249 .id_table = tm_devices,
250 .probe = tm_probe,
251};
H Hartley Sweetenf4254582012-12-17 15:28:26 -0700252module_hid_driver(tm_driver);
Jiri Slaby10e41a72008-09-18 12:23:31 +0200253
Jiri Slaby10e41a72008-09-18 12:23:31 +0200254MODULE_LICENSE("GPL");