Documentation/input/ff.rst

   1 ========================
   2 Force feedback for Linux
   3 ========================
   4
   5 :Author: Johann Deneux <johann.deneux@gmail.com> on 2001/04/22.
   6 :Updated: Anssi Hannula <anssi.hannula@gmail.com> on 2006/04/09.
   7
   8 You may redistribute this file. Please remember to include shape.svg and
   9 interactive.svg as well.
  10
  11 Introduction
  12 ~~~~~~~~~~~~
  13
  14 This document describes how to use force feedback devices under Linux. The
  15 goal is not to support these devices as if they were simple input-only devices
  16 (as it is already the case), but to really enable the rendering of force
  17 effects.
  18 This document only describes the force feedback part of the Linux input
  19 interface. Please read joystick.txt and input.txt before reading further this
  20 document.
  21
  22 Instructions to the user
  23 ~~~~~~~~~~~~~~~~~~~~~~~~
  24
  25 To enable force feedback, you have to:
  26
  27 1. have your kernel configured with evdev and a driver that supports your
  28    device.
  29 2. make sure evdev module is loaded and /dev/input/event* device files are
  30    created.
  31
  32 Before you start, let me WARN you that some devices shake violently during the
  33 initialisation phase. This happens for example with my "AVB Top Shot Pegasus".
  34 To stop this annoying behaviour, move you joystick to its limits. Anyway, you
  35 should keep a hand on your device, in order to avoid it to break down if
  36 something goes wrong.
  37
  38 If you have a serial iforce device, you need to start inputattach. See
  39 joystick.txt for details.
  40
  41 Does it work ?
  42 --------------
  43
  44 There is an utility called fftest that will allow you to test the driver::
  45
  46     % fftest /dev/input/eventXX
  47
  48 Instructions to the developer
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 All interactions are done using the event API. That is, you can use ioctl()
  52 and write() on /dev/input/eventXX.
  53 This information is subject to change.
  54
  55 Querying device capabilities
  56 ----------------------------
  57
  58 ::
  59
  60     #include <linux/input.h>
  61     #include <sys/ioctl.h>
  62
  63     #define BITS_TO_LONGS(x) \
  64             (((x) + 8 * sizeof (unsigned long) - 1) / (8 * sizeof (unsigned long)))
  65     unsigned long features[BITS_TO_LONGS(FF_CNT)];
  66     int ioctl(int file_descriptor, int request, unsigned long *features);
  67
  68 "request" must be EVIOCGBIT(EV_FF, size of features array in bytes )
  69
  70 Returns the features supported by the device. features is a bitfield with the
  71 following bits:
  72
  73 - FF_CONSTANT   can render constant force effects
  74 - FF_PERIODIC   can render periodic effects with the following waveforms:
  75
  76   - FF_SQUARE     square waveform
  77   - FF_TRIANGLE   triangle waveform
  78   - FF_SINE       sine waveform
  79   - FF_SAW_UP     sawtooth up waveform
  80   - FF_SAW_DOWN   sawtooth down waveform
  81   - FF_CUSTOM     custom waveform
  82
  83 - FF_RAMP       can render ramp effects
  84 - FF_SPRING     can simulate the presence of a spring
  85 - FF_FRICTION   can simulate friction
  86 - FF_DAMPER     can simulate damper effects
  87 - FF_RUMBLE     rumble effects
  88 - FF_INERTIA    can simulate inertia
  89 - FF_GAIN       gain is adjustable
  90 - FF_AUTOCENTER autocenter is adjustable
  91
  92 .. note::
  93
  94     - In most cases you should use FF_PERIODIC instead of FF_RUMBLE. All
  95       devices that support FF_RUMBLE support FF_PERIODIC (square, triangle,
  96       sine) and the other way around.
  97
  98     - The exact syntax FF_CUSTOM is undefined for the time being as no driver
  99       supports it yet.
 100
 101 ::
 102
 103     int ioctl(int fd, EVIOCGEFFECTS, int *n);
 104
 105 Returns the number of effects the device can keep in its memory.
 106
 107 Uploading effects to the device
 108 -------------------------------
 109
 110 ::
 111
 112     #include <linux/input.h>
 113     #include <sys/ioctl.h>
 114
 115     int ioctl(int file_descriptor, int request, struct ff_effect *effect);
 116
 117 "request" must be EVIOCSFF.
 118
 119 "effect" points to a structure describing the effect to upload. The effect is
 120 uploaded, but not played.
 121 The content of effect may be modified. In particular, its field "id" is set
 122 to the unique id assigned by the driver. This data is required for performing
 123 some operations (removing an effect, controlling the playback).
 124 This if field must be set to -1 by the user in order to tell the driver to
 125 allocate a new effect.
 126
 127 Effects are file descriptor specific.
 128
 129 See <linux/input.h> for a description of the ff_effect struct. You should also
 130 find help in a few sketches, contained in files shape.svg and interactive.svg:
 131
 132 .. figure:: shape.svg
 133
 134     Shape
 135
 136 .. figure:: interactive.svg
 137
 138     Interactive
 139
 140
 141 Removing an effect from the device
 142 ----------------------------------
 143
 144 ::
 145
 146     int ioctl(int fd, EVIOCRMFF, effect.id);
 147
 148 This makes room for new effects in the device's memory. Note that this also
 149 stops the effect if it was playing.
 150
 151 Controlling the playback of effects
 152 -----------------------------------
 153
 154 Control of playing is done with write(). Below is an example:
 155
 156 ::
 157
 158     #include <linux/input.h>
 159     #include <unistd.h>
 160
 161         struct input_event play;
 162         struct input_event stop;
 163         struct ff_effect effect;
 164         int fd;
 165    ...
 166         fd = open("/dev/input/eventXX", O_RDWR);
 167    ...
 168         /* Play three times */
 169         play.type = EV_FF;
 170         play.code = effect.id;
 171         play.value = 3;
 172
 173         write(fd, (const void*) &play, sizeof(play));
 174    ...
 175         /* Stop an effect */
 176         stop.type = EV_FF;
 177         stop.code = effect.id;
 178         stop.value = 0;
 179
 180         write(fd, (const void*) &play, sizeof(stop));
 181
 182 Setting the gain
 183 ----------------
 184
 185 Not all devices have the same strength. Therefore, users should set a gain
 186 factor depending on how strong they want effects to be. This setting is
 187 persistent across access to the driver.
 188
 189 ::
 190
 191     /* Set the gain of the device
 192     int gain;           /* between 0 and 100 */
 193     struct input_event ie;      /* structure used to communicate with the driver */
 194
 195     ie.type = EV_FF;
 196     ie.code = FF_GAIN;
 197     ie.value = 0xFFFFUL * gain / 100;
 198
 199     if (write(fd, &ie, sizeof(ie)) == -1)
 200         perror("set gain");
 201
 202 Enabling/Disabling autocenter
 203 -----------------------------
 204
 205 The autocenter feature quite disturbs the rendering of effects in my opinion,
 206 and I think it should be an effect, which computation depends on the game
 207 type. But you can enable it if you want.
 208
 209 ::
 210
 211     int autocenter;             /* between 0 and 100 */
 212     struct input_event ie;
 213
 214     ie.type = EV_FF;
 215     ie.code = FF_AUTOCENTER;
 216     ie.value = 0xFFFFUL * autocenter / 100;
 217
 218     if (write(fd, &ie, sizeof(ie)) == -1)
 219         perror("set auto-center");
 220
 221 A value of 0 means "no auto-center".
 222
 223 Dynamic update of an effect
 224 ---------------------------
 225
 226 Proceed as if you wanted to upload a new effect, except that instead of
 227 setting the id field to -1, you set it to the wanted effect id.
 228 Normally, the effect is not stopped and restarted. However, depending on the
 229 type of device, not all parameters can be dynamically updated. For example,
 230 the direction of an effect cannot be updated with iforce devices. In this
 231 case, the driver stops the effect, up-load it, and restart it.
 232
 233 Therefore it is recommended to dynamically change direction while the effect
 234 is playing only when it is ok to restart the effect with a replay count of 1.
 235
 236 Information about the status of effects
 237 ---------------------------------------
 238
 239 Every time the status of an effect is changed, an event is sent. The values
 240 and meanings of the fields of the event are as follows::
 241
 242     struct input_event {
 243     /* When the status of the effect changed */
 244             struct timeval time;
 245
 246     /* Set to EV_FF_STATUS */
 247             unsigned short type;
 248
 249     /* Contains the id of the effect */
 250             unsigned short code;
 251
 252     /* Indicates the status */
 253             unsigned int value;
 254     };
 255
 256     FF_STATUS_STOPPED   The effect stopped playing
 257     FF_STATUS_PLAYING   The effect started to play
 258
 259 .. note::
 260
 261     - Status feedback is only supported by iforce driver. If you have
 262       a really good reason to use this, please contact
 263       linux-joystick@atrey.karlin.mff.cuni.cz or anssi.hannula@gmail.com
 264       so that support for it can be added to the rest of the drivers.