xref: /openbmc/linux/drivers/hid/hid-zpff.c (revision 8fa5723aa7e053d498336b48448b292fc2e0458b)
1 /*
2  *  Force feedback support for Zeroplus based devices
3  *
4  *  Copyright (c) 2005, 2006 Anssi Hannula <anssi.hannula@gmail.com>
5  */
6 
7 /*
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21  */
22 
23 
24 #include <linux/hid.h>
25 #include <linux/input.h>
26 #include <linux/usb.h>
27 
28 #include "hid-ids.h"
29 
30 #include "usbhid/usbhid.h"
31 
32 struct zpff_device {
33 	struct hid_report *report;
34 };
35 
36 static int zpff_play(struct input_dev *dev, void *data,
37 			 struct ff_effect *effect)
38 {
39 	struct hid_device *hid = input_get_drvdata(dev);
40 	struct zpff_device *zpff = data;
41 	int left, right;
42 
43 	/*
44 	 * The following is specified the other way around in the Zeroplus
45 	 * datasheet but the order below is correct for the XFX Executioner;
46 	 * however it is possible that the XFX Executioner is an exception
47 	 */
48 
49 	left = effect->u.rumble.strong_magnitude;
50 	right = effect->u.rumble.weak_magnitude;
51 	dbg_hid("called with 0x%04x 0x%04x\n", left, right);
52 
53 	left = left * 0x7f / 0xffff;
54 	right = right * 0x7f / 0xffff;
55 
56 	zpff->report->field[2]->value[0] = left;
57 	zpff->report->field[3]->value[0] = right;
58 	dbg_hid("running with 0x%02x 0x%02x\n", left, right);
59 	usbhid_submit_report(hid, zpff->report, USB_DIR_OUT);
60 
61 	return 0;
62 }
63 
64 static int zpff_init(struct hid_device *hid)
65 {
66 	struct zpff_device *zpff;
67 	struct hid_report *report;
68 	struct hid_input *hidinput = list_entry(hid->inputs.next,
69 						struct hid_input, list);
70 	struct list_head *report_list =
71 			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
72 	struct input_dev *dev = hidinput->input;
73 	int error;
74 
75 	if (list_empty(report_list)) {
76 		dev_err(&hid->dev, "no output report found\n");
77 		return -ENODEV;
78 	}
79 
80 	report = list_entry(report_list->next, struct hid_report, list);
81 
82 	if (report->maxfield < 4) {
83 		dev_err(&hid->dev, "not enough fields in report\n");
84 		return -ENODEV;
85 	}
86 
87 	zpff = kzalloc(sizeof(struct zpff_device), GFP_KERNEL);
88 	if (!zpff)
89 		return -ENOMEM;
90 
91 	set_bit(FF_RUMBLE, dev->ffbit);
92 
93 	error = input_ff_create_memless(dev, zpff, zpff_play);
94 	if (error) {
95 		kfree(zpff);
96 		return error;
97 	}
98 
99 	zpff->report = report;
100 	zpff->report->field[0]->value[0] = 0x00;
101 	zpff->report->field[1]->value[0] = 0x02;
102 	zpff->report->field[2]->value[0] = 0x00;
103 	zpff->report->field[3]->value[0] = 0x00;
104 	usbhid_submit_report(hid, zpff->report, USB_DIR_OUT);
105 
106 	dev_info(&hid->dev, "force feedback for Zeroplus based devices by "
107 	       "Anssi Hannula <anssi.hannula@gmail.com>\n");
108 
109 	return 0;
110 }
111 
112 static int zp_probe(struct hid_device *hdev, const struct hid_device_id *id)
113 {
114 	int ret;
115 
116 	ret = hid_parse(hdev);
117 	if (ret) {
118 		dev_err(&hdev->dev, "parse failed\n");
119 		goto err;
120 	}
121 
122 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
123 	if (ret) {
124 		dev_err(&hdev->dev, "hw start failed\n");
125 		goto err;
126 	}
127 
128 	zpff_init(hdev);
129 
130 	return 0;
131 err:
132 	return ret;
133 }
134 
135 static const struct hid_device_id zp_devices[] = {
136 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0005) },
137 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0030) },
138 	{ }
139 };
140 MODULE_DEVICE_TABLE(hid, zp_devices);
141 
142 static struct hid_driver zp_driver = {
143 	.name = "zeroplus",
144 	.id_table = zp_devices,
145 	.probe = zp_probe,
146 };
147 
148 static int zp_init(void)
149 {
150 	return hid_register_driver(&zp_driver);
151 }
152 
153 static void zp_exit(void)
154 {
155 	hid_unregister_driver(&zp_driver);
156 }
157 
158 module_init(zp_init);
159 module_exit(zp_exit);
160 MODULE_LICENSE("GPL");
161 
162 HID_COMPAT_LOAD_DRIVER(zeroplus);
163