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