11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2d946e65eSAnssi Hannula /*
3d946e65eSAnssi Hannula * Force feedback support for Holtek On Line Grip based gamepads
4d946e65eSAnssi Hannula *
5d946e65eSAnssi Hannula * These include at least a Brazilian "Clone Joypad Super Power Fire"
6d946e65eSAnssi Hannula * which uses vendor ID 0x1241 and identifies as "HOLTEK On Line Grip".
7d946e65eSAnssi Hannula *
8d946e65eSAnssi Hannula * Copyright (c) 2011 Anssi Hannula <anssi.hannula@iki.fi>
9d946e65eSAnssi Hannula */
10d946e65eSAnssi Hannula
11d946e65eSAnssi Hannula /*
12d946e65eSAnssi Hannula */
13d946e65eSAnssi Hannula
14d946e65eSAnssi Hannula #include <linux/hid.h>
15d946e65eSAnssi Hannula #include <linux/input.h>
168f86a2c3SPaul Gortmaker #include <linux/module.h>
17d946e65eSAnssi Hannula #include <linux/slab.h>
18d946e65eSAnssi Hannula
19d946e65eSAnssi Hannula #include "hid-ids.h"
20d946e65eSAnssi Hannula
21d946e65eSAnssi Hannula #ifdef CONFIG_HOLTEK_FF
22d946e65eSAnssi Hannula
23d946e65eSAnssi Hannula /*
24d946e65eSAnssi Hannula * These commands and parameters are currently known:
25d946e65eSAnssi Hannula *
26d946e65eSAnssi Hannula * byte 0: command id:
27d946e65eSAnssi Hannula * 01 set effect parameters
28d946e65eSAnssi Hannula * 02 play specified effect
29d946e65eSAnssi Hannula * 03 stop specified effect
30d946e65eSAnssi Hannula * 04 stop all effects
31d946e65eSAnssi Hannula * 06 stop all effects
32d946e65eSAnssi Hannula * (the difference between 04 and 06 isn't known; win driver
33d946e65eSAnssi Hannula * sends 06,04 on application init, and 06 otherwise)
34d946e65eSAnssi Hannula *
35d946e65eSAnssi Hannula * Commands 01 and 02 need to be sent as pairs, i.e. you need to send 01
36d946e65eSAnssi Hannula * before each 02.
37d946e65eSAnssi Hannula *
38d946e65eSAnssi Hannula * The rest of the bytes are parameters. Command 01 takes all of them, and
39d946e65eSAnssi Hannula * commands 02,03 take only the effect id.
40d946e65eSAnssi Hannula *
41d946e65eSAnssi Hannula * byte 1:
42d946e65eSAnssi Hannula * bits 0-3: effect id:
43d946e65eSAnssi Hannula * 1: very strong rumble
44d946e65eSAnssi Hannula * 2: periodic rumble, short intervals
45d946e65eSAnssi Hannula * 3: very strong rumble
46d946e65eSAnssi Hannula * 4: periodic rumble, long intervals
47d946e65eSAnssi Hannula * 5: weak periodic rumble, long intervals
48d946e65eSAnssi Hannula * 6: weak periodic rumble, short intervals
49d946e65eSAnssi Hannula * 7: periodic rumble, short intervals
50d946e65eSAnssi Hannula * 8: strong periodic rumble, short intervals
51d946e65eSAnssi Hannula * 9: very strong rumble
52d946e65eSAnssi Hannula * a: causes an error
53d946e65eSAnssi Hannula * b: very strong periodic rumble, very short intervals
54d946e65eSAnssi Hannula * c-f: nothing
55d946e65eSAnssi Hannula * bit 6: right (weak) motor enabled
56d946e65eSAnssi Hannula * bit 7: left (strong) motor enabled
57d946e65eSAnssi Hannula *
58d946e65eSAnssi Hannula * bytes 2-3: time in milliseconds, big-endian
59d946e65eSAnssi Hannula * bytes 5-6: unknown (win driver seems to use at least 10e0 with effect 1
60d946e65eSAnssi Hannula * and 0014 with effect 6)
61d946e65eSAnssi Hannula * byte 7:
62d946e65eSAnssi Hannula * bits 0-3: effect magnitude
63d946e65eSAnssi Hannula */
64d946e65eSAnssi Hannula
65d946e65eSAnssi Hannula #define HOLTEKFF_MSG_LENGTH 7
66d946e65eSAnssi Hannula
67d946e65eSAnssi Hannula static const u8 start_effect_1[] = { 0x02, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 };
68d946e65eSAnssi Hannula static const u8 stop_all4[] = { 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
69d946e65eSAnssi Hannula static const u8 stop_all6[] = { 0x06, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
70d946e65eSAnssi Hannula
71d946e65eSAnssi Hannula struct holtekff_device {
72d946e65eSAnssi Hannula struct hid_field *field;
73d946e65eSAnssi Hannula };
74d946e65eSAnssi Hannula
holtekff_send(struct holtekff_device * holtekff,struct hid_device * hid,const u8 data[HOLTEKFF_MSG_LENGTH])75d946e65eSAnssi Hannula static void holtekff_send(struct holtekff_device *holtekff,
76d946e65eSAnssi Hannula struct hid_device *hid,
77d946e65eSAnssi Hannula const u8 data[HOLTEKFF_MSG_LENGTH])
78d946e65eSAnssi Hannula {
79d946e65eSAnssi Hannula int i;
80d946e65eSAnssi Hannula
81d946e65eSAnssi Hannula for (i = 0; i < HOLTEKFF_MSG_LENGTH; i++) {
82d946e65eSAnssi Hannula holtekff->field->value[i] = data[i];
83d946e65eSAnssi Hannula }
84d946e65eSAnssi Hannula
859854a6f9SAndy Shevchenko dbg_hid("sending %7ph\n", data);
86d946e65eSAnssi Hannula
87d8814272SBenjamin Tissoires hid_hw_request(hid, holtekff->field->report, HID_REQ_SET_REPORT);
88d946e65eSAnssi Hannula }
89d946e65eSAnssi Hannula
holtekff_play(struct input_dev * dev,void * data,struct ff_effect * effect)90d946e65eSAnssi Hannula static int holtekff_play(struct input_dev *dev, void *data,
91d946e65eSAnssi Hannula struct ff_effect *effect)
92d946e65eSAnssi Hannula {
93d946e65eSAnssi Hannula struct hid_device *hid = input_get_drvdata(dev);
94d946e65eSAnssi Hannula struct holtekff_device *holtekff = data;
95d946e65eSAnssi Hannula int left, right;
96d946e65eSAnssi Hannula /* effect type 1, length 65535 msec */
97d946e65eSAnssi Hannula u8 buf[HOLTEKFF_MSG_LENGTH] =
98d946e65eSAnssi Hannula { 0x01, 0x01, 0xff, 0xff, 0x10, 0xe0, 0x00 };
99d946e65eSAnssi Hannula
100d946e65eSAnssi Hannula left = effect->u.rumble.strong_magnitude;
101d946e65eSAnssi Hannula right = effect->u.rumble.weak_magnitude;
102d946e65eSAnssi Hannula dbg_hid("called with 0x%04x 0x%04x\n", left, right);
103d946e65eSAnssi Hannula
104d946e65eSAnssi Hannula if (!left && !right) {
105d946e65eSAnssi Hannula holtekff_send(holtekff, hid, stop_all6);
106d946e65eSAnssi Hannula return 0;
107d946e65eSAnssi Hannula }
108d946e65eSAnssi Hannula
109d946e65eSAnssi Hannula if (left)
110d946e65eSAnssi Hannula buf[1] |= 0x80;
111d946e65eSAnssi Hannula if (right)
112d946e65eSAnssi Hannula buf[1] |= 0x40;
113d946e65eSAnssi Hannula
114d946e65eSAnssi Hannula /* The device takes a single magnitude, so we just sum them up. */
115d946e65eSAnssi Hannula buf[6] = min(0xf, (left >> 12) + (right >> 12));
116d946e65eSAnssi Hannula
117d946e65eSAnssi Hannula holtekff_send(holtekff, hid, buf);
118d946e65eSAnssi Hannula holtekff_send(holtekff, hid, start_effect_1);
119d946e65eSAnssi Hannula
120d946e65eSAnssi Hannula return 0;
121d946e65eSAnssi Hannula }
122d946e65eSAnssi Hannula
holtekff_init(struct hid_device * hid)123d946e65eSAnssi Hannula static int holtekff_init(struct hid_device *hid)
124d946e65eSAnssi Hannula {
125d946e65eSAnssi Hannula struct holtekff_device *holtekff;
126d946e65eSAnssi Hannula struct hid_report *report;
127d9d4b1e4SAlan Stern struct hid_input *hidinput;
128d946e65eSAnssi Hannula struct list_head *report_list =
129d946e65eSAnssi Hannula &hid->report_enum[HID_OUTPUT_REPORT].report_list;
130d9d4b1e4SAlan Stern struct input_dev *dev;
131d946e65eSAnssi Hannula int error;
132d946e65eSAnssi Hannula
133d9d4b1e4SAlan Stern if (list_empty(&hid->inputs)) {
134d9d4b1e4SAlan Stern hid_err(hid, "no inputs found\n");
135d9d4b1e4SAlan Stern return -ENODEV;
136d9d4b1e4SAlan Stern }
137d9d4b1e4SAlan Stern hidinput = list_entry(hid->inputs.next, struct hid_input, list);
138d9d4b1e4SAlan Stern dev = hidinput->input;
139d9d4b1e4SAlan Stern
140d946e65eSAnssi Hannula if (list_empty(report_list)) {
141d946e65eSAnssi Hannula hid_err(hid, "no output report found\n");
142d946e65eSAnssi Hannula return -ENODEV;
143d946e65eSAnssi Hannula }
144d946e65eSAnssi Hannula
145d946e65eSAnssi Hannula report = list_entry(report_list->next, struct hid_report, list);
146d946e65eSAnssi Hannula
147d946e65eSAnssi Hannula if (report->maxfield < 1 || report->field[0]->report_count != 7) {
148d946e65eSAnssi Hannula hid_err(hid, "unexpected output report layout\n");
149d946e65eSAnssi Hannula return -ENODEV;
150d946e65eSAnssi Hannula }
151d946e65eSAnssi Hannula
152d946e65eSAnssi Hannula holtekff = kzalloc(sizeof(*holtekff), GFP_KERNEL);
153d946e65eSAnssi Hannula if (!holtekff)
154d946e65eSAnssi Hannula return -ENOMEM;
155d946e65eSAnssi Hannula
156d946e65eSAnssi Hannula set_bit(FF_RUMBLE, dev->ffbit);
157d946e65eSAnssi Hannula
158d946e65eSAnssi Hannula holtekff->field = report->field[0];
159d946e65eSAnssi Hannula
160d946e65eSAnssi Hannula /* initialize the same way as win driver does */
161d946e65eSAnssi Hannula holtekff_send(holtekff, hid, stop_all4);
162d946e65eSAnssi Hannula holtekff_send(holtekff, hid, stop_all6);
163d946e65eSAnssi Hannula
164d946e65eSAnssi Hannula error = input_ff_create_memless(dev, holtekff, holtekff_play);
165d946e65eSAnssi Hannula if (error) {
166d946e65eSAnssi Hannula kfree(holtekff);
167d946e65eSAnssi Hannula return error;
168d946e65eSAnssi Hannula }
169d946e65eSAnssi Hannula
170d946e65eSAnssi Hannula hid_info(hid, "Force feedback for Holtek On Line Grip based devices by Anssi Hannula <anssi.hannula@iki.fi>\n");
171d946e65eSAnssi Hannula
172d946e65eSAnssi Hannula return 0;
173d946e65eSAnssi Hannula }
174d946e65eSAnssi Hannula #else
holtekff_init(struct hid_device * hid)175d946e65eSAnssi Hannula static inline int holtekff_init(struct hid_device *hid)
176d946e65eSAnssi Hannula {
177d946e65eSAnssi Hannula return 0;
178d946e65eSAnssi Hannula }
179d946e65eSAnssi Hannula #endif
180d946e65eSAnssi Hannula
holtek_probe(struct hid_device * hdev,const struct hid_device_id * id)181d946e65eSAnssi Hannula static int holtek_probe(struct hid_device *hdev, const struct hid_device_id *id)
182d946e65eSAnssi Hannula {
183d946e65eSAnssi Hannula int ret;
184d946e65eSAnssi Hannula
185d946e65eSAnssi Hannula ret = hid_parse(hdev);
186d946e65eSAnssi Hannula if (ret) {
187d946e65eSAnssi Hannula hid_err(hdev, "parse failed\n");
188d946e65eSAnssi Hannula goto err;
189d946e65eSAnssi Hannula }
190d946e65eSAnssi Hannula
191d946e65eSAnssi Hannula ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
192d946e65eSAnssi Hannula if (ret) {
193d946e65eSAnssi Hannula hid_err(hdev, "hw start failed\n");
194d946e65eSAnssi Hannula goto err;
195d946e65eSAnssi Hannula }
196d946e65eSAnssi Hannula
197d946e65eSAnssi Hannula holtekff_init(hdev);
198d946e65eSAnssi Hannula
199d946e65eSAnssi Hannula return 0;
200d946e65eSAnssi Hannula err:
201d946e65eSAnssi Hannula return ret;
202d946e65eSAnssi Hannula }
203d946e65eSAnssi Hannula
204d946e65eSAnssi Hannula static const struct hid_device_id holtek_devices[] = {
205d946e65eSAnssi Hannula { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK, USB_DEVICE_ID_HOLTEK_ON_LINE_GRIP) },
206d946e65eSAnssi Hannula { }
207d946e65eSAnssi Hannula };
208d946e65eSAnssi Hannula MODULE_DEVICE_TABLE(hid, holtek_devices);
209d946e65eSAnssi Hannula
210d946e65eSAnssi Hannula static struct hid_driver holtek_driver = {
211d946e65eSAnssi Hannula .name = "holtek",
212d946e65eSAnssi Hannula .id_table = holtek_devices,
213d946e65eSAnssi Hannula .probe = holtek_probe,
214d946e65eSAnssi Hannula };
215f425458eSH Hartley Sweeten module_hid_driver(holtek_driver);
21656075f60SDaniel Axtens
21756075f60SDaniel Axtens MODULE_LICENSE("GPL");
21856075f60SDaniel Axtens MODULE_AUTHOR("Anssi Hannula <anssi.hannula@iki.fi>");
21956075f60SDaniel Axtens MODULE_DESCRIPTION("Force feedback support for Holtek On Line Grip based devices");
220