1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * When connected to the machine, the Thrustmaster wheels appear as
4 * a «generic» hid gamepad called "Thrustmaster FFB Wheel".
5 *
6 * When in this mode not every functionality of the wheel, like the force feedback,
7 * are available. To enable all functionalities of a Thrustmaster wheel we have to send
8 * to it a specific USB CONTROL request with a code different for each wheel.
9 *
10 * This driver tries to understand which model of Thrustmaster wheel the generic
11 * "Thrustmaster FFB Wheel" really is and then sends the appropriate control code.
12 *
13 * Copyright (c) 2020-2021 Dario Pagani <dario.pagani.146+linuxk@gmail.com>
14 * Copyright (c) 2020-2021 Kim Kuparinen <kimi.h.kuparinen@gmail.com>
15 */
16 #include <linux/hid.h>
17 #include <linux/usb.h>
18 #include <linux/input.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21
22 /*
23 * These interrupts are used to prevent a nasty crash when initializing the
24 * T300RS. Used in thrustmaster_interrupts().
25 */
26 static const u8 setup_0[] = { 0x42, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
27 static const u8 setup_1[] = { 0x0a, 0x04, 0x90, 0x03, 0x00, 0x00, 0x00, 0x00 };
28 static const u8 setup_2[] = { 0x0a, 0x04, 0x00, 0x0c, 0x00, 0x00, 0x00, 0x00 };
29 static const u8 setup_3[] = { 0x0a, 0x04, 0x12, 0x10, 0x00, 0x00, 0x00, 0x00 };
30 static const u8 setup_4[] = { 0x0a, 0x04, 0x00, 0x06, 0x00, 0x00, 0x00, 0x00 };
31 static const u8 *const setup_arr[] = { setup_0, setup_1, setup_2, setup_3, setup_4 };
32 static const unsigned int setup_arr_sizes[] = {
33 ARRAY_SIZE(setup_0),
34 ARRAY_SIZE(setup_1),
35 ARRAY_SIZE(setup_2),
36 ARRAY_SIZE(setup_3),
37 ARRAY_SIZE(setup_4)
38 };
39 /*
40 * This struct contains for each type of
41 * Thrustmaster wheel
42 *
43 * Note: The values are stored in the CPU
44 * endianness, the USB protocols always use
45 * little endian; the macro cpu_to_le[BIT]()
46 * must be used when preparing USB packets
47 * and vice-versa
48 */
49 struct tm_wheel_info {
50 uint16_t wheel_type;
51
52 /*
53 * See when the USB control out packet is prepared...
54 * @TODO The TMX seems to require multiple control codes to switch.
55 */
56 uint16_t switch_value;
57
58 char const *const wheel_name;
59 };
60
61 /*
62 * Known wheels.
63 * Note: TMX does not work as it requires 2 control packets
64 */
65 static const struct tm_wheel_info tm_wheels_infos[] = {
66 {0x0306, 0x0006, "Thrustmaster T150RS"},
67 {0x0206, 0x0005, "Thrustmaster T300RS"},
68 {0x0204, 0x0005, "Thrustmaster T300 Ferrari Alcantara Edition"},
69 {0x0002, 0x0002, "Thrustmaster T500RS"}
70 //{0x0407, 0x0001, "Thrustmaster TMX"}
71 };
72
73 static const uint8_t tm_wheels_infos_length = 4;
74
75 /*
76 * This structs contains (in little endian) the response data
77 * of the wheel to the request 73
78 *
79 * A sufficient research to understand what each field does is not
80 * beign conducted yet. The position and meaning of fields are a
81 * just a very optimistic guess based on instinct....
82 */
83 struct __packed tm_wheel_response
84 {
85 /*
86 * Seems to be the type of packet
87 * - 0x0049 if is data.a (15 bytes)
88 * - 0x0047 if is data.b (7 bytes)
89 */
90 uint16_t type;
91
92 union {
93 struct __packed {
94 uint16_t field0;
95 uint16_t field1;
96 /*
97 * Seems to be the model code of the wheel
98 * Read table thrustmaster_wheels to values
99 */
100 uint16_t model;
101
102 uint16_t field2;
103 uint16_t field3;
104 uint16_t field4;
105 uint16_t field5;
106 } a;
107 struct __packed {
108 uint16_t field0;
109 uint16_t field1;
110 uint16_t model;
111 } b;
112 } data;
113 };
114
115 struct tm_wheel {
116 struct usb_device *usb_dev;
117 struct urb *urb;
118
119 struct usb_ctrlrequest *model_request;
120 struct tm_wheel_response *response;
121
122 struct usb_ctrlrequest *change_request;
123 };
124
125 /* The control packet to send to wheel */
126 static const struct usb_ctrlrequest model_request = {
127 .bRequestType = 0xc1,
128 .bRequest = 73,
129 .wValue = 0,
130 .wIndex = 0,
131 .wLength = cpu_to_le16(0x0010)
132 };
133
134 static const struct usb_ctrlrequest change_request = {
135 .bRequestType = 0x41,
136 .bRequest = 83,
137 .wValue = 0, // Will be filled by the driver
138 .wIndex = 0,
139 .wLength = 0
140 };
141
142 /*
143 * On some setups initializing the T300RS crashes the kernel,
144 * these interrupts fix that particular issue. So far they haven't caused any
145 * adverse effects in other wheels.
146 */
thrustmaster_interrupts(struct hid_device * hdev)147 static void thrustmaster_interrupts(struct hid_device *hdev)
148 {
149 int ret, trans, i, b_ep;
150 u8 *send_buf = kmalloc(256, GFP_KERNEL);
151 struct usb_host_endpoint *ep;
152 struct device *dev = &hdev->dev;
153 struct usb_interface *usbif = to_usb_interface(dev->parent);
154 struct usb_device *usbdev = interface_to_usbdev(usbif);
155
156 if (!send_buf) {
157 hid_err(hdev, "failed allocating send buffer\n");
158 return;
159 }
160
161 ep = &usbif->cur_altsetting->endpoint[1];
162 b_ep = ep->desc.bEndpointAddress;
163
164 for (i = 0; i < ARRAY_SIZE(setup_arr); ++i) {
165 memcpy(send_buf, setup_arr[i], setup_arr_sizes[i]);
166
167 ret = usb_interrupt_msg(usbdev,
168 usb_sndintpipe(usbdev, b_ep),
169 send_buf,
170 setup_arr_sizes[i],
171 &trans,
172 USB_CTRL_SET_TIMEOUT);
173
174 if (ret) {
175 hid_err(hdev, "setup data couldn't be sent\n");
176 kfree(send_buf);
177 return;
178 }
179 }
180
181 kfree(send_buf);
182 }
183
thrustmaster_change_handler(struct urb * urb)184 static void thrustmaster_change_handler(struct urb *urb)
185 {
186 struct hid_device *hdev = urb->context;
187
188 // The wheel seems to kill himself before answering the host and therefore is violating the USB protocol...
189 if (urb->status == 0 || urb->status == -EPROTO || urb->status == -EPIPE)
190 hid_info(hdev, "Success?! The wheel should have been initialized!\n");
191 else
192 hid_warn(hdev, "URB to change wheel mode seems to have failed with error %d\n", urb->status);
193 }
194
195 /*
196 * Called by the USB subsystem when the wheel responses to our request
197 * to get [what it seems to be] the wheel's model.
198 *
199 * If the model id is recognized then we send an opportune USB CONTROL REQUEST
200 * to switch the wheel to its full capabilities
201 */
thrustmaster_model_handler(struct urb * urb)202 static void thrustmaster_model_handler(struct urb *urb)
203 {
204 struct hid_device *hdev = urb->context;
205 struct tm_wheel *tm_wheel = hid_get_drvdata(hdev);
206 uint16_t model = 0;
207 int i, ret;
208 const struct tm_wheel_info *twi = NULL;
209
210 if (urb->status) {
211 hid_err(hdev, "URB to get model id failed with error %d\n", urb->status);
212 return;
213 }
214
215 if (tm_wheel->response->type == cpu_to_le16(0x49))
216 model = le16_to_cpu(tm_wheel->response->data.a.model);
217 else if (tm_wheel->response->type == cpu_to_le16(0x47))
218 model = le16_to_cpu(tm_wheel->response->data.b.model);
219 else {
220 hid_err(hdev, "Unknown packet type 0x%x, unable to proceed further with wheel init\n", tm_wheel->response->type);
221 return;
222 }
223
224 for (i = 0; i < tm_wheels_infos_length && !twi; i++)
225 if (tm_wheels_infos[i].wheel_type == model)
226 twi = tm_wheels_infos + i;
227
228 if (twi)
229 hid_info(hdev, "Wheel with model id 0x%x is a %s\n", model, twi->wheel_name);
230 else {
231 hid_err(hdev, "Unknown wheel's model id 0x%x, unable to proceed further with wheel init\n", model);
232 return;
233 }
234
235 tm_wheel->change_request->wValue = cpu_to_le16(twi->switch_value);
236 usb_fill_control_urb(
237 tm_wheel->urb,
238 tm_wheel->usb_dev,
239 usb_sndctrlpipe(tm_wheel->usb_dev, 0),
240 (char *)tm_wheel->change_request,
241 NULL, 0, // We do not expect any response from the wheel
242 thrustmaster_change_handler,
243 hdev
244 );
245
246 ret = usb_submit_urb(tm_wheel->urb, GFP_ATOMIC);
247 if (ret)
248 hid_err(hdev, "Error %d while submitting the change URB. I am unable to initialize this wheel...\n", ret);
249 }
250
thrustmaster_remove(struct hid_device * hdev)251 static void thrustmaster_remove(struct hid_device *hdev)
252 {
253 struct tm_wheel *tm_wheel = hid_get_drvdata(hdev);
254
255 usb_kill_urb(tm_wheel->urb);
256
257 kfree(tm_wheel->change_request);
258 kfree(tm_wheel->response);
259 kfree(tm_wheel->model_request);
260 usb_free_urb(tm_wheel->urb);
261 kfree(tm_wheel);
262
263 hid_hw_stop(hdev);
264 }
265
266 /*
267 * Function called by HID when a hid Thrustmaster FFB wheel is connected to the host.
268 * This function starts the hid dev, tries to allocate the tm_wheel data structure and
269 * finally send an USB CONTROL REQUEST to the wheel to get [what it seems to be] its
270 * model type.
271 */
thrustmaster_probe(struct hid_device * hdev,const struct hid_device_id * id)272 static int thrustmaster_probe(struct hid_device *hdev, const struct hid_device_id *id)
273 {
274 int ret = 0;
275 struct tm_wheel *tm_wheel = NULL;
276
277 if (!hid_is_usb(hdev))
278 return -EINVAL;
279
280 ret = hid_parse(hdev);
281 if (ret) {
282 hid_err(hdev, "parse failed with error %d\n", ret);
283 goto error0;
284 }
285
286 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
287 if (ret) {
288 hid_err(hdev, "hw start failed with error %d\n", ret);
289 goto error0;
290 }
291
292 // Now we allocate the tm_wheel
293 tm_wheel = kzalloc(sizeof(struct tm_wheel), GFP_KERNEL);
294 if (!tm_wheel) {
295 ret = -ENOMEM;
296 goto error1;
297 }
298
299 tm_wheel->urb = usb_alloc_urb(0, GFP_ATOMIC);
300 if (!tm_wheel->urb) {
301 ret = -ENOMEM;
302 goto error2;
303 }
304
305 tm_wheel->model_request = kmemdup(&model_request,
306 sizeof(struct usb_ctrlrequest),
307 GFP_KERNEL);
308 if (!tm_wheel->model_request) {
309 ret = -ENOMEM;
310 goto error3;
311 }
312
313 tm_wheel->response = kzalloc(sizeof(struct tm_wheel_response), GFP_KERNEL);
314 if (!tm_wheel->response) {
315 ret = -ENOMEM;
316 goto error4;
317 }
318
319 tm_wheel->change_request = kmemdup(&change_request,
320 sizeof(struct usb_ctrlrequest),
321 GFP_KERNEL);
322 if (!tm_wheel->change_request) {
323 ret = -ENOMEM;
324 goto error5;
325 }
326
327 tm_wheel->usb_dev = interface_to_usbdev(to_usb_interface(hdev->dev.parent));
328 hid_set_drvdata(hdev, tm_wheel);
329
330 thrustmaster_interrupts(hdev);
331
332 usb_fill_control_urb(
333 tm_wheel->urb,
334 tm_wheel->usb_dev,
335 usb_rcvctrlpipe(tm_wheel->usb_dev, 0),
336 (char *)tm_wheel->model_request,
337 tm_wheel->response,
338 sizeof(struct tm_wheel_response),
339 thrustmaster_model_handler,
340 hdev
341 );
342
343 ret = usb_submit_urb(tm_wheel->urb, GFP_ATOMIC);
344 if (ret) {
345 hid_err(hdev, "Error %d while submitting the URB. I am unable to initialize this wheel...\n", ret);
346 goto error6;
347 }
348
349 return ret;
350
351 error6: kfree(tm_wheel->change_request);
352 error5: kfree(tm_wheel->response);
353 error4: kfree(tm_wheel->model_request);
354 error3: usb_free_urb(tm_wheel->urb);
355 error2: kfree(tm_wheel);
356 error1: hid_hw_stop(hdev);
357 error0:
358 return ret;
359 }
360
361 static const struct hid_device_id thrustmaster_devices[] = {
362 { HID_USB_DEVICE(0x044f, 0xb65d)},
363 {}
364 };
365
366 MODULE_DEVICE_TABLE(hid, thrustmaster_devices);
367
368 static struct hid_driver thrustmaster_driver = {
369 .name = "hid-thrustmaster",
370 .id_table = thrustmaster_devices,
371 .probe = thrustmaster_probe,
372 .remove = thrustmaster_remove,
373 };
374
375 module_hid_driver(thrustmaster_driver);
376
377 MODULE_AUTHOR("Dario Pagani <dario.pagani.146+linuxk@gmail.com>");
378 MODULE_LICENSE("GPL");
379 MODULE_DESCRIPTION("Driver to initialize some steering wheel joysticks from Thrustmaster");
380
381