drivers/hid/hid-lg3ff.c

   1 /*
   2  *  Force feedback support for Logitech Flight System G940
   3  *
   4  *  Copyright (c) 2009 Gary Stein <LordCnidarian@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/input.h>
  25 #include <linux/usb.h>
  26 #include <linux/hid.h>
  27
  28 #include "usbhid/usbhid.h"
  29 #include "hid-lg.h"
  30
  31 /*
  32  * G940 Theory of Operation (from experimentation)
  33  *
  34  * There are 63 fields (only 3 of them currently used)
  35  * 0 - seems to be command field
  36  * 1 - 30 deal with the x axis
  37  * 31 -60 deal with the y axis
  38  *
  39  * Field 1 is x axis constant force
  40  * Field 31 is y axis constant force
  41  *
  42  * other interesting fields 1,2,3,4 on x axis
  43  * (same for 31,32,33,34 on y axis)
  44  *
  45  * 0 0 127 127 makes the joystick autocenter hard
  46  *
  47  * 127 0 127 127 makes the joystick loose on the right,
  48  * but stops all movemnt left
  49  *
  50  * -127 0 -127 -127 makes the joystick loose on the left,
  51  * but stops all movement right
  52  *
  53  * 0 0 -127 -127 makes the joystick rattle very hard
  54  *
  55  * I'm sure these are effects that I don't know enough about them
  56  */
  57
  58 struct lg3ff_device {
  59         struct hid_report *report;
  60 };
  61
  62 static int hid_lg3ff_play(struct input_dev *dev, void *data,
  63                          struct ff_effect *effect)
  64 {
  65         struct hid_device *hid = input_get_drvdata(dev);
  66         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
  67         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
  68         int x, y;
  69
  70 /*
  71  * Available values in the field should always be 63, but we only use up to
  72  * 35. Instead, clear the entire area, however big it is.
  73  */
  74         memset(report->field[0]->value, 0,
  75                sizeof(__s32) * report->field[0]->report_count);
  76
  77         switch (effect->type) {
  78         case FF_CONSTANT:
  79 /*
  80  * Already clamped in ff_memless
  81  * 0 is center (different then other logitech)
  82  */
  83                 x = effect->u.ramp.start_level;
  84                 y = effect->u.ramp.end_level;
  85
  86                 /* send command byte */
  87                 report->field[0]->value[0] = 0x51;
  88
  89 /*
  90  * Sign backwards from other Force3d pro
  91  * which get recast here in two's complement 8 bits
  92  */
  93                 report->field[0]->value[1] = (unsigned char)(-x);
  94                 report->field[0]->value[31] = (unsigned char)(-y);
  95
  96                 usbhid_submit_report(hid, report, USB_DIR_OUT);
  97                 break;
  98         }
  99         return 0;
 100 }
 101 static void hid_lg3ff_set_autocenter(struct input_dev *dev, u16 magnitude)
 102 {
 103         struct hid_device *hid = input_get_drvdata(dev);
 104         struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 105         struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
 106
 107 /*
 108  * Auto Centering probed from device
 109  * NOTE: deadman's switch on G940 must be covered
 110  * for effects to work
 111  */
 112         report->field[0]->value[0] = 0x51;
 113         report->field[0]->value[1] = 0x00;
 114         report->field[0]->value[2] = 0x00;
 115         report->field[0]->value[3] = 0x7F;
 116         report->field[0]->value[4] = 0x7F;
 117         report->field[0]->value[31] = 0x00;
 118         report->field[0]->value[32] = 0x00;
 119         report->field[0]->value[33] = 0x7F;
 120         report->field[0]->value[34] = 0x7F;
 121
 122         usbhid_submit_report(hid, report, USB_DIR_OUT);
 123 }
 124
 125
 126 static const signed short ff3_joystick_ac[] = {
 127         FF_CONSTANT,
 128         FF_AUTOCENTER,
 129         -1
 130 };
 131
 132 int lg3ff_init(struct hid_device *hid)
 133 {
 134         struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
 135         struct input_dev *dev = hidinput->input;
 136         const signed short *ff_bits = ff3_joystick_ac;
 137         int error;
 138         int i;
 139
 140         /* Check that the report looks ok */
 141         if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 35))
 142                 return -ENODEV;
 143
 144         /* Assume single fixed device G940 */
 145         for (i = 0; ff_bits[i] >= 0; i++)
 146                 set_bit(ff_bits[i], dev->ffbit);
 147
 148         error = input_ff_create_memless(dev, NULL, hid_lg3ff_play);
 149         if (error)
 150                 return error;
 151
 152         if (test_bit(FF_AUTOCENTER, dev->ffbit))
 153                 dev->ff->set_autocenter = hid_lg3ff_set_autocenter;
 154
 155         hid_info(hid, "Force feedback for Logitech Flight System G940 by Gary Stein <LordCnidarian@gmail.com>\n");
 156         return 0;
 157 }
 158