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 #include <linux/input.h>
  31 #include <linux/usb.h>
  32 #include <linux/hid.h>
  33
  34 #include "usbhid/usbhid.h"
  35 #include "hid-lg.h"
  36
  37 struct dev_type {
  38         u16 idVendor;
  39         u16 idProduct;
  40         const signed short *ff;
  41 };
  42
  43 static const signed short ff_rumble[] = {
  44         FF_RUMBLE,
  45         -1
  46 };
  47
  48 static const signed short ff_joystick[] = {
  49         FF_CONSTANT,
  50         -1
  51 };
  52
  53 static const signed short ff_joystick_ac[] = {
  54         FF_CONSTANT,
  55         FF_AUTOCENTER,
  56         -1
  57 };
  58
  59 static const signed short ff_wheel[] = {
  60         FF_CONSTANT,
  61         FF_AUTOCENTER,
  62         -1
  63 };
  64
  65 static const struct dev_type devices[] = {
  66         { 0x046d, 0xc211, ff_rumble },
  67         { 0x046d, 0xc219, ff_rumble },
  68         { 0x046d, 0xc283, ff_joystick },
  69         { 0x046d, 0xc286, ff_joystick_ac },
  70         { 0x046d, 0xc294, ff_wheel },
  71         { 0x046d, 0xc295, ff_joystick },
  72         { 0x046d, 0xca03, ff_wheel },
  73 };
  74
  75 static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
  76 {
  77         struct hid_device *hid = input_get_drvdata(dev);
  78         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
  79         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
  80         int x, y;
  81         unsigned int left, right;
  82
  83 #define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
  84
  85         switch (effect->type) {
  86         case FF_CONSTANT:
  87                 x = effect->u.ramp.start_level + 0x7f;  /* 0x7f is center */
  88                 y = effect->u.ramp.end_level + 0x7f;
  89                 CLAMP(x);
  90                 CLAMP(y);
  91                 report->field[0]->value[0] = 0x51;
  92                 report->field[0]->value[1] = 0x08;
  93                 report->field[0]->value[2] = x;
  94                 report->field[0]->value[3] = y;
  95                 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
  96                 usbhid_submit_report(hid, report, USB_DIR_OUT);
  97                 break;
  98
  99         case FF_RUMBLE:
 100                 right = effect->u.rumble.strong_magnitude;
 101                 left = effect->u.rumble.weak_magnitude;
 102                 right = right * 0xff / 0xffff;
 103                 left = left * 0xff / 0xffff;
 104                 CLAMP(left);
 105                 CLAMP(right);
 106                 report->field[0]->value[0] = 0x42;
 107                 report->field[0]->value[1] = 0x00;
 108                 report->field[0]->value[2] = left;
 109                 report->field[0]->value[3] = right;
 110                 dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
 111                 usbhid_submit_report(hid, report, USB_DIR_OUT);
 112                 break;
 113         }
 114         return 0;
 115 }
 116
 117 static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
 118 {
 119         struct hid_device *hid = input_get_drvdata(dev);
 120         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 121         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
 122         __s32 *value = report->field[0]->value;
 123         magnitude = (magnitude >> 12) & 0xf;
 124         *value++ = 0xfe;
 125         *value++ = 0x0d;
 126         *value++ = magnitude;   /* clockwise strength */
 127         *value++ = magnitude;   /* counter-clockwise strength */
 128         *value++ = 0x80;
 129         *value++ = 0x00;
 130         *value = 0x00;
 131         usbhid_submit_report(hid, report, USB_DIR_OUT);
 132 }
 133
 134 int lgff_init(struct hid_device* hid)
 135 {
 136         struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
 137         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 138         struct input_dev *dev = hidinput->input;
 139         struct hid_report *report;
 140         struct hid_field *field;
 141         const signed short *ff_bits = ff_joystick;
 142         int error;
 143         int i;
 144
 145         /* Find the report to use */
 146         if (list_empty(report_list)) {
 147                 err_hid("No output report found");
 148                 return -1;
 149         }
 150
 151         /* Check that the report looks ok */
 152         report = list_entry(report_list->next, struct hid_report, list);
 153         if (!report) {
 154                 err_hid("NULL output report");
 155                 return -1;
 156         }
 157
 158         field = report->field[0];
 159         if (!field) {
 160                 err_hid("NULL field");
 161                 return -1;
 162         }
 163
 164         for (i = 0; i < ARRAY_SIZE(devices); i++) {
 165                 if (dev->id.vendor == devices[i].idVendor &&
 166                     dev->id.product == devices[i].idProduct) {
 167                         ff_bits = devices[i].ff;
 168                         break;
 169                 }
 170         }
 171
 172         for (i = 0; ff_bits[i] >= 0; i++)
 173                 set_bit(ff_bits[i], dev->ffbit);
 174
 175         error = input_ff_create_memless(dev, NULL, hid_lgff_play);
 176         if (error)
 177                 return error;
 178
 179         if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
 180                 dev->ff->set_autocenter = hid_lgff_set_autocenter;
 181
 182         printk(KERN_INFO "Force feedback for Logitech force feedback devices by Johann Deneux <johann.deneux@it.uu.se>\n");
 183
 184         return 0;
 185 }