xref: /openbmc/linux/drivers/hid/hid-zpff.c (revision d78c317f)
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/slab.h>
27 #include <linux/usb.h>
28 #include <linux/module.h>
29 
30 #include "hid-ids.h"
31 
32 #ifdef CONFIG_ZEROPLUS_FF
33 #include "usbhid/usbhid.h"
34 
35 struct zpff_device {
36 	struct hid_report *report;
37 };
38 
39 static int zpff_play(struct input_dev *dev, void *data,
40 			 struct ff_effect *effect)
41 {
42 	struct hid_device *hid = input_get_drvdata(dev);
43 	struct zpff_device *zpff = data;
44 	int left, right;
45 
46 	/*
47 	 * The following is specified the other way around in the Zeroplus
48 	 * datasheet but the order below is correct for the XFX Executioner;
49 	 * however it is possible that the XFX Executioner is an exception
50 	 */
51 
52 	left = effect->u.rumble.strong_magnitude;
53 	right = effect->u.rumble.weak_magnitude;
54 	dbg_hid("called with 0x%04x 0x%04x\n", left, right);
55 
56 	left = left * 0x7f / 0xffff;
57 	right = right * 0x7f / 0xffff;
58 
59 	zpff->report->field[2]->value[0] = left;
60 	zpff->report->field[3]->value[0] = right;
61 	dbg_hid("running with 0x%02x 0x%02x\n", left, right);
62 	usbhid_submit_report(hid, zpff->report, USB_DIR_OUT);
63 
64 	return 0;
65 }
66 
67 static int zpff_init(struct hid_device *hid)
68 {
69 	struct zpff_device *zpff;
70 	struct hid_report *report;
71 	struct hid_input *hidinput = list_entry(hid->inputs.next,
72 						struct hid_input, list);
73 	struct list_head *report_list =
74 			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
75 	struct input_dev *dev = hidinput->input;
76 	int error;
77 
78 	if (list_empty(report_list)) {
79 		hid_err(hid, "no output report found\n");
80 		return -ENODEV;
81 	}
82 
83 	report = list_entry(report_list->next, struct hid_report, list);
84 
85 	if (report->maxfield < 4) {
86 		hid_err(hid, "not enough fields in report\n");
87 		return -ENODEV;
88 	}
89 
90 	zpff = kzalloc(sizeof(struct zpff_device), GFP_KERNEL);
91 	if (!zpff)
92 		return -ENOMEM;
93 
94 	set_bit(FF_RUMBLE, dev->ffbit);
95 
96 	error = input_ff_create_memless(dev, zpff, zpff_play);
97 	if (error) {
98 		kfree(zpff);
99 		return error;
100 	}
101 
102 	zpff->report = report;
103 	zpff->report->field[0]->value[0] = 0x00;
104 	zpff->report->field[1]->value[0] = 0x02;
105 	zpff->report->field[2]->value[0] = 0x00;
106 	zpff->report->field[3]->value[0] = 0x00;
107 	usbhid_submit_report(hid, zpff->report, USB_DIR_OUT);
108 
109 	hid_info(hid, "force feedback for Zeroplus based devices by Anssi Hannula <anssi.hannula@gmail.com>\n");
110 
111 	return 0;
112 }
113 #else
114 static inline int zpff_init(struct hid_device *hid)
115 {
116 	return 0;
117 }
118 #endif
119 
120 static int zp_probe(struct hid_device *hdev, const struct hid_device_id *id)
121 {
122 	int ret;
123 
124 	ret = hid_parse(hdev);
125 	if (ret) {
126 		hid_err(hdev, "parse failed\n");
127 		goto err;
128 	}
129 
130 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
131 	if (ret) {
132 		hid_err(hdev, "hw start failed\n");
133 		goto err;
134 	}
135 
136 	zpff_init(hdev);
137 
138 	return 0;
139 err:
140 	return ret;
141 }
142 
143 static const struct hid_device_id zp_devices[] = {
144 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0005) },
145 	{ HID_USB_DEVICE(USB_VENDOR_ID_ZEROPLUS, 0x0030) },
146 	{ }
147 };
148 MODULE_DEVICE_TABLE(hid, zp_devices);
149 
150 static struct hid_driver zp_driver = {
151 	.name = "zeroplus",
152 	.id_table = zp_devices,
153 	.probe = zp_probe,
154 };
155 
156 static int __init zp_init(void)
157 {
158 	return hid_register_driver(&zp_driver);
159 }
160 
161 static void __exit zp_exit(void)
162 {
163 	hid_unregister_driver(&zp_driver);
164 }
165 
166 module_init(zp_init);
167 module_exit(zp_exit);
168 MODULE_LICENSE("GPL");
169