1STRUCT FF_PERIODIC_E(9)         Input Subsystem        STRUCT FF_PERIODIC_E(9)
2
3
4

NAME

6       struct_ff_periodic_effect - defines parameters of a periodic
7       force-feedback effect
8

SYNOPSIS

10       struct ff_periodic_effect {
11         __u16 waveform;
12         __u16 period;
13         __s16 magnitude;
14         __s16 offset;
15         __u16 phase;
16         struct ff_envelope envelope;
17         __u32 custom_len;
18         __s16 __user * custom_data;
19       };
20

MEMBERS

22       waveform
23           kind of the effect (wave)
24
25       period
26           period of the wave (ms)
27
28       magnitude
29           peak value
30
31       offset
32           mean value of the wave (roughly)
33
34       phase
35           'horizontal' shift
36
37       envelope
38           envelope data
39
40       custom_len
41           number of samples (FF_CUSTOM only)
42
43       custom_data
44           buffer of samples (FF_CUSTOM only)
45

DESCRIPTION

47       Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
48       FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined for the
49       time being as no driver supports it yet.
50

NOTE

52       the data pointed by custom_data is copied by the driver. You can
53       therefore dispose of the memory after the upload/update.
54

56Kernel Hackers Manual 2.6.       November 2011         STRUCT FF_PERIODIC_E(9)
Impressum