xref: /openbmc/linux/drivers/hid/hid-betopff.c (revision 3180449e)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Force feedback support for Betop based devices
4  *
5  *  The devices are distributed under various names and the same USB device ID
6  *  can be used in both adapters and actual game controllers.
7  *
8  *  0x11c2:0x2208 "BTP2185 BFM mode Joystick"
9  *   - tested with BTP2185 BFM Mode.
10  *
11  *  0x11C0:0x5506 "BTP2185 PC mode Joystick"
12  *   - tested with BTP2185 PC Mode.
13  *
14  *  0x8380:0x1850 "BTP2185 V2 PC mode USB Gamepad"
15  *   - tested with BTP2185 PC Mode with another version.
16  *
17  *  0x20bc:0x5500 "BTP2185 V2 BFM mode Joystick"
18  *   - tested with BTP2171s.
19  *  Copyright (c) 2014 Huang Bo <huangbobupt@163.com>
20  */
21 
22 /*
23  */
24 
25 
26 #include <linux/input.h>
27 #include <linux/slab.h>
28 #include <linux/module.h>
29 #include <linux/hid.h>
30 
31 #include "hid-ids.h"
32 
33 struct betopff_device {
34 	struct hid_report *report;
35 };
36 
37 static int hid_betopff_play(struct input_dev *dev, void *data,
38 			 struct ff_effect *effect)
39 {
40 	struct hid_device *hid = input_get_drvdata(dev);
41 	struct betopff_device *betopff = data;
42 	__u16 left, right;
43 
44 	left = effect->u.rumble.strong_magnitude;
45 	right = effect->u.rumble.weak_magnitude;
46 
47 	betopff->report->field[2]->value[0] = left / 256;
48 	betopff->report->field[3]->value[0] = right / 256;
49 
50 	hid_hw_request(hid, betopff->report, HID_REQ_SET_REPORT);
51 
52 	return 0;
53 }
54 
55 static int betopff_init(struct hid_device *hid)
56 {
57 	struct betopff_device *betopff;
58 	struct hid_report *report;
59 	struct hid_input *hidinput;
60 	struct list_head *report_list =
61 			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
62 	struct input_dev *dev;
63 	int error;
64 	int i, j;
65 
66 	if (list_empty(&hid->inputs)) {
67 		hid_err(hid, "no inputs found\n");
68 		return -ENODEV;
69 	}
70 
71 	hidinput = list_first_entry(&hid->inputs, struct hid_input, list);
72 	dev = hidinput->input;
73 
74 	if (list_empty(report_list)) {
75 		hid_err(hid, "no output reports found\n");
76 		return -ENODEV;
77 	}
78 
79 	report = list_first_entry(report_list, struct hid_report, list);
80 	/*
81 	 * Actually there are 4 fields for 4 Bytes as below:
82 	 * -----------------------------------------
83 	 * Byte0  Byte1  Byte2	  Byte3
84 	 * 0x00   0x00   left_motor right_motor
85 	 * -----------------------------------------
86 	 * Do init them with default value.
87 	 */
88 	if (report->maxfield < 4) {
89 		hid_err(hid, "not enough fields in the report: %d\n",
90 				report->maxfield);
91 		return -ENODEV;
92 	}
93 	for (i = 0; i < report->maxfield; i++) {
94 		if (report->field[i]->report_count < 1) {
95 			hid_err(hid, "no values in the field\n");
96 			return -ENODEV;
97 		}
98 		for (j = 0; j < report->field[i]->report_count; j++) {
99 			report->field[i]->value[j] = 0x00;
100 		}
101 	}
102 
103 	betopff = kzalloc(sizeof(*betopff), GFP_KERNEL);
104 	if (!betopff)
105 		return -ENOMEM;
106 
107 	set_bit(FF_RUMBLE, dev->ffbit);
108 
109 	error = input_ff_create_memless(dev, betopff, hid_betopff_play);
110 	if (error) {
111 		kfree(betopff);
112 		return error;
113 	}
114 
115 	betopff->report = report;
116 	hid_hw_request(hid, betopff->report, HID_REQ_SET_REPORT);
117 
118 	hid_info(hid, "Force feedback for betop devices by huangbo <huangbobupt@163.com>\n");
119 
120 	return 0;
121 }
122 
123 static int betop_probe(struct hid_device *hdev, const struct hid_device_id *id)
124 {
125 	int ret;
126 
127 	if (id->driver_data)
128 		hdev->quirks |= HID_QUIRK_MULTI_INPUT;
129 
130 	ret = hid_parse(hdev);
131 	if (ret) {
132 		hid_err(hdev, "parse failed\n");
133 		goto err;
134 	}
135 
136 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
137 	if (ret) {
138 		hid_err(hdev, "hw start failed\n");
139 		goto err;
140 	}
141 
142 	betopff_init(hdev);
143 
144 	return 0;
145 err:
146 	return ret;
147 }
148 
149 static const struct hid_device_id betop_devices[] = {
150 	{ HID_USB_DEVICE(USB_VENDOR_ID_BETOP_2185BFM, 0x2208) },
151 	{ HID_USB_DEVICE(USB_VENDOR_ID_BETOP_2185PC, 0x5506) },
152 	{ HID_USB_DEVICE(USB_VENDOR_ID_BETOP_2185V2PC, 0x1850) },
153 	{ HID_USB_DEVICE(USB_VENDOR_ID_BETOP_2185V2BFM, 0x5500) },
154 	{ }
155 };
156 MODULE_DEVICE_TABLE(hid, betop_devices);
157 
158 static struct hid_driver betop_driver = {
159 	.name = "betop",
160 	.id_table = betop_devices,
161 	.probe = betop_probe,
162 };
163 module_hid_driver(betop_driver);
164 
165 MODULE_LICENSE("GPL");
166