drivers/hid/hid-lgff.c

   1 /*
   2  * Force feedback support for hid-compliant for some of the devices from
   3  * Logitech, namely:
   4  * - WingMan Cordless RumblePad
   5  * - WingMan Force 3D
   6  *
   7  *  Copyright (c) 2002-2004 Johann Deneux
   8  *  Copyright (c) 2006 Anssi Hannula <anssi.hannula@gmail.com>
   9  */
  10
  11 /*
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  25  *
  26  * Should you need to contact me, the author, you can do so by
  27  * e-mail - mail your message to <johann.deneux@it.uu.se>
  28  */
  29
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/input.h>
  33 #include <linux/usb.h>
  34 #include <linux/hid.h>
  35
  36 #include "usbhid/usbhid.h"
  37 #include "hid-lg.h"
  38
  39 struct dev_type {
  40         u16 idVendor;
  41         u16 idProduct;
  42         const signed short *ff;
  43 };
  44
  45 static const signed short ff_rumble[] = {
  46         FF_RUMBLE,
  47         -1
  48 };
  49
  50 static const signed short ff_joystick[] = {
  51         FF_CONSTANT,
  52         -1
  53 };
  54
  55 static const signed short ff_joystick_ac[] = {
  56         FF_CONSTANT,
  57         FF_AUTOCENTER,
  58         -1
  59 };
  60
  61 static const signed short ff_wheel[] = {
  62         FF_CONSTANT,
  63         FF_AUTOCENTER,
  64         -1
  65 };
  66
  67 static const struct dev_type devices[] = {
  68         { 0x046d, 0xc211, ff_rumble },
  69         { 0x046d, 0xc219, ff_rumble },
  70         { 0x046d, 0xc283, ff_joystick },
  71         { 0x046d, 0xc286, ff_joystick_ac },
  72         { 0x046d, 0xc287, ff_joystick_ac },
  73         { 0x046d, 0xc293, ff_joystick },
  74         { 0x046d, 0xc294, ff_wheel },
  75         { 0x046d, 0xc298, ff_wheel },
  76         { 0x046d, 0xc299, ff_wheel },
  77         { 0x046d, 0xc29b, ff_wheel },
  78         { 0x046d, 0xc295, ff_joystick },
  79         { 0x046d, 0xc298, ff_wheel },
  80         { 0x046d, 0xc299, ff_wheel },
  81         { 0x046d, 0xca03, ff_wheel },
  82 };
  83
  84 static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
  85 {
  86         struct hid_device *hid = input_get_drvdata(dev);
  87         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
  88         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
  89         int x, y;
  90         unsigned int left, right;
  91
  92 #define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
  93
  94         switch (effect->type) {
  95         case FF_CONSTANT:
  96                 x = effect->u.ramp.start_level + 0x7f;  /* 0x7f is center */
  97                 y = effect->u.ramp.end_level + 0x7f;
  98                 CLAMP(x);
  99                 CLAMP(y);
 100                 report->field[0]->value[0] = 0x51;
 101                 report->field[0]->value[1] = 0x08;
 102                 report->field[0]->value[2] = x;
 103                 report->field[0]->value[3] = y;
 104                 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
 105                 usbhid_submit_report(hid, report, USB_DIR_OUT);
 106                 break;
 107
 108         case FF_RUMBLE:
 109                 right = effect->u.rumble.strong_magnitude;
 110                 left = effect->u.rumble.weak_magnitude;
 111                 right = right * 0xff / 0xffff;
 112                 left = left * 0xff / 0xffff;
 113                 CLAMP(left);
 114                 CLAMP(right);
 115                 report->field[0]->value[0] = 0x42;
 116                 report->field[0]->value[1] = 0x00;
 117                 report->field[0]->value[2] = left;
 118                 report->field[0]->value[3] = right;
 119                 dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
 120                 usbhid_submit_report(hid, report, USB_DIR_OUT);
 121                 break;
 122         }
 123         return 0;
 124 }
 125
 126 static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
 127 {
 128         struct hid_device *hid = input_get_drvdata(dev);
 129         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 130         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
 131         __s32 *value = report->field[0]->value;
 132         magnitude = (magnitude >> 12) & 0xf;
 133         *value++ = 0xfe;
 134         *value++ = 0x0d;
 135         *value++ = magnitude;   /* clockwise strength */
 136         *value++ = magnitude;   /* counter-clockwise strength */
 137         *value++ = 0x80;
 138         *value++ = 0x00;
 139         *value = 0x00;
 140         usbhid_submit_report(hid, report, USB_DIR_OUT);
 141 }
 142
 143 int lgff_init(struct hid_device* hid)
 144 {
 145         struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
 146         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 147         struct input_dev *dev = hidinput->input;
 148         struct hid_report *report;
 149         struct hid_field *field;
 150         const signed short *ff_bits = ff_joystick;
 151         int error;
 152         int i;
 153
 154         /* Find the report to use */
 155         if (list_empty(report_list)) {
 156                 hid_err(hid, "No output report found\n");
 157                 return -1;
 158         }
 159
 160         /* Check that the report looks ok */
 161         report = list_entry(report_list->next, struct hid_report, list);
 162         field = report->field[0];
 163         if (!field) {
 164                 hid_err(hid, "NULL field\n");
 165                 return -1;
 166         }
 167
 168         for (i = 0; i < ARRAY_SIZE(devices); i++) {
 169                 if (dev->id.vendor == devices[i].idVendor &&
 170                     dev->id.product == devices[i].idProduct) {
 171                         ff_bits = devices[i].ff;
 172                         break;
 173                 }
 174         }
 175
 176         for (i = 0; ff_bits[i] >= 0; i++)
 177                 set_bit(ff_bits[i], dev->ffbit);
 178
 179         error = input_ff_create_memless(dev, NULL, hid_lgff_play);
 180         if (error)
 181                 return error;
 182
 183         if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
 184                 dev->ff->set_autocenter = hid_lgff_set_autocenter;
 185
 186         pr_info("Force feedback for Logitech force feedback devices by Johann Deneux <johann.deneux@it.uu.se>\n");
 187
 188         return 0;
 189 }