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