linux/drivers/hid/hid-tmff.c
<<
>>
Prefs
   1/*
   2 * Force feedback support for various HID compliant devices by ThrustMaster:
   3 *    ThrustMaster FireStorm Dual Power 2
   4 * and possibly others whose device ids haven't been added.
   5 *
   6 *  Modified to support ThrustMaster devices by Zinx Verituse
   7 *  on 2003-01-25 from the Logitech force feedback driver,
   8 *  which is by Johann Deneux.
   9 *
  10 *  Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
  11 *  Copyright (c) 2002 Johann Deneux
  12 */
  13
  14/*
  15 * This program is free software; you can redistribute it and/or modify
  16 * it under the terms of the GNU General Public License as published by
  17 * the Free Software Foundation; either version 2 of the License, or
  18 * (at your option) any later version.
  19 *
  20 * This program is distributed in the hope that it will be useful,
  21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 * GNU General Public License for more details.
  24 *
  25 * You should have received a copy of the GNU General Public License
  26 * along with this program; if not, write to the Free Software
  27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  28 */
  29
  30#include <linux/hid.h>
  31#include <linux/input.h>
  32#include <linux/slab.h>
  33#include <linux/usb.h>
  34
  35#include "hid-ids.h"
  36
  37static const signed short ff_rumble[] = {
  38        FF_RUMBLE,
  39        -1
  40};
  41
  42static const signed short ff_joystick[] = {
  43        FF_CONSTANT,
  44        -1
  45};
  46
  47#ifdef CONFIG_THRUSTMASTER_FF
  48#include "usbhid/usbhid.h"
  49
  50/* Usages for thrustmaster devices I know about */
  51#define THRUSTMASTER_USAGE_FF   (HID_UP_GENDESK | 0xbb)
  52
  53struct tmff_device {
  54        struct hid_report *report;
  55        struct hid_field *ff_field;
  56};
  57
  58/* Changes values from 0 to 0xffff into values from minimum to maximum */
  59static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
  60{
  61        int ret;
  62
  63        ret = (in * (maximum - minimum) / 0xffff) + minimum;
  64        if (ret < minimum)
  65                return minimum;
  66        if (ret > maximum)
  67                return maximum;
  68        return ret;
  69}
  70
  71/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
  72static inline int tmff_scale_s8(int in, int minimum, int maximum)
  73{
  74        int ret;
  75
  76        ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
  77        if (ret < minimum)
  78                return minimum;
  79        if (ret > maximum)
  80                return maximum;
  81        return ret;
  82}
  83
  84static int tmff_play(struct input_dev *dev, void *data,
  85                struct ff_effect *effect)
  86{
  87        struct hid_device *hid = input_get_drvdata(dev);
  88        struct tmff_device *tmff = data;
  89        struct hid_field *ff_field = tmff->ff_field;
  90        int x, y;
  91        int left, right;        /* Rumbling */
  92
  93        switch (effect->type) {
  94        case FF_CONSTANT:
  95                x = tmff_scale_s8(effect->u.ramp.start_level,
  96                                        ff_field->logical_minimum,
  97                                        ff_field->logical_maximum);
  98                y = tmff_scale_s8(effect->u.ramp.end_level,
  99                                        ff_field->logical_minimum,
 100                                        ff_field->logical_maximum);
 101
 102                dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
 103                ff_field->value[0] = x;
 104                ff_field->value[1] = y;
 105                usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
 106                break;
 107
 108        case FF_RUMBLE:
 109                left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
 110                                        ff_field->logical_minimum,
 111                                        ff_field->logical_maximum);
 112                right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
 113                                        ff_field->logical_minimum,
 114                                        ff_field->logical_maximum);
 115
 116                dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
 117                ff_field->value[0] = left;
 118                ff_field->value[1] = right;
 119                usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
 120                break;
 121        }
 122        return 0;
 123}
 124
 125static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
 126{
 127        struct tmff_device *tmff;
 128        struct hid_report *report;
 129        struct list_head *report_list;
 130        struct hid_input *hidinput = list_entry(hid->inputs.next,
 131                                                        struct hid_input, list);
 132        struct input_dev *input_dev = hidinput->input;
 133        int error;
 134        int i;
 135
 136        tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
 137        if (!tmff)
 138                return -ENOMEM;
 139
 140        /* Find the report to use */
 141        report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 142        list_for_each_entry(report, report_list, list) {
 143                int fieldnum;
 144
 145                for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
 146                        struct hid_field *field = report->field[fieldnum];
 147
 148                        if (field->maxusage <= 0)
 149                                continue;
 150
 151                        switch (field->usage[0].hid) {
 152                        case THRUSTMASTER_USAGE_FF:
 153                                if (field->report_count < 2) {
 154                                        hid_warn(hid, "ignoring FF field with report_count < 2\n");
 155                                        continue;
 156                                }
 157
 158                                if (field->logical_maximum ==
 159                                                field->logical_minimum) {
 160                                        hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
 161                                        continue;
 162                                }
 163
 164                                if (tmff->report && tmff->report != report) {
 165                                        hid_warn(hid, "ignoring FF field in other report\n");
 166                                        continue;
 167                                }
 168
 169                                if (tmff->ff_field && tmff->ff_field != field) {
 170                                        hid_warn(hid, "ignoring duplicate FF field\n");
 171                                        continue;
 172                                }
 173
 174                                tmff->report = report;
 175                                tmff->ff_field = field;
 176
 177                                for (i = 0; ff_bits[i] >= 0; i++)
 178                                        set_bit(ff_bits[i], input_dev->ffbit);
 179
 180                                break;
 181
 182                        default:
 183                                hid_warn(hid, "ignoring unknown output usage %08x\n",
 184                                         field->usage[0].hid);
 185                                continue;
 186                        }
 187                }
 188        }
 189
 190        if (!tmff->report) {
 191                hid_err(hid, "can't find FF field in output reports\n");
 192                error = -ENODEV;
 193                goto fail;
 194        }
 195
 196        error = input_ff_create_memless(input_dev, tmff, tmff_play);
 197        if (error)
 198                goto fail;
 199
 200        hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
 201        return 0;
 202
 203fail:
 204        kfree(tmff);
 205        return error;
 206}
 207#else
 208static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
 209{
 210        return 0;
 211}
 212#endif
 213
 214static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
 215{
 216        int ret;
 217
 218        ret = hid_parse(hdev);
 219        if (ret) {
 220                hid_err(hdev, "parse failed\n");
 221                goto err;
 222        }
 223
 224        ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
 225        if (ret) {
 226                hid_err(hdev, "hw start failed\n");
 227                goto err;
 228        }
 229
 230        tmff_init(hdev, (void *)id->driver_data);
 231
 232        return 0;
 233err:
 234        return ret;
 235}
 236
 237static const struct hid_device_id tm_devices[] = {
 238        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
 239                .driver_data = (unsigned long)ff_rumble },
 240        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304),   /* FireStorm Dual Power 2 (and 3) */
 241                .driver_data = (unsigned long)ff_rumble },
 242        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323),   /* Dual Trigger 3-in-1 (PC Mode) */
 243                .driver_data = (unsigned long)ff_rumble },
 244        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324),   /* Dual Trigger 3-in-1 (PS3 Mode) */
 245                .driver_data = (unsigned long)ff_rumble },
 246        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651),   /* FGT Rumble Force Wheel */
 247                .driver_data = (unsigned long)ff_rumble },
 248        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653),   /* RGT Force Feedback CLUTCH Raging Wheel */
 249                .driver_data = (unsigned long)ff_joystick },
 250        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654),   /* FGT Force Feedback Wheel */
 251                .driver_data = (unsigned long)ff_joystick },
 252        { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a),   /* F430 Force Feedback Wheel */
 253                .driver_data = (unsigned long)ff_joystick },
 254        { }
 255};
 256MODULE_DEVICE_TABLE(hid, tm_devices);
 257
 258static struct hid_driver tm_driver = {
 259        .name = "thrustmaster",
 260        .id_table = tm_devices,
 261        .probe = tm_probe,
 262};
 263
 264static int __init tm_init(void)
 265{
 266        return hid_register_driver(&tm_driver);
 267}
 268
 269static void __exit tm_exit(void)
 270{
 271        hid_unregister_driver(&tm_driver);
 272}
 273
 274module_init(tm_init);
 275module_exit(tm_exit);
 276MODULE_LICENSE("GPL");
 277