include/uapi/linux/input.h

   1 /*
   2  * Copyright (c) 1999-2002 Vojtech Pavlik
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 as published by
   6  * the Free Software Foundation.
   7  */
   8 #ifndef _UAPI_INPUT_H
   9 #define _UAPI_INPUT_H
  10
  11
  12 #ifndef __KERNEL__
  13 #include <sys/time.h>
  14 #include <sys/ioctl.h>
  15 #include <sys/types.h>
  16 #include <linux/types.h>
  17 #endif
  18
  19 #include "input-event-codes.h"
  20
  21 /*
  22  * The event structure itself
  23  */
  24
  25 struct input_event {
  26         struct timeval time;
  27         __u16 type;
  28         __u16 code;
  29         __s32 value;
  30 };
  31
  32 /*
  33  * Protocol version.
  34  */
  35
  36 #define EV_VERSION              0x010001
  37
  38 /*
  39  * IOCTLs (0x00 - 0x7f)
  40  */
  41
  42 struct input_id {
  43         __u16 bustype;
  44         __u16 vendor;
  45         __u16 product;
  46         __u16 version;
  47 };
  48
  49 /**
  50  * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
  51  * @value: latest reported value for the axis.
  52  * @minimum: specifies minimum value for the axis.
  53  * @maximum: specifies maximum value for the axis.
  54  * @fuzz: specifies fuzz value that is used to filter noise from
  55  *      the event stream.
  56  * @flat: values that are within this value will be discarded by
  57  *      joydev interface and reported as 0 instead.
  58  * @resolution: specifies resolution for the values reported for
  59  *      the axis.
  60  *
  61  * Note that input core does not clamp reported values to the
  62  * [minimum, maximum] limits, such task is left to userspace.
  63  *
  64  * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
  65  * units per millimeter (units/mm), resolution for rotational axes
  66  * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
  67  */
  68 struct input_absinfo {
  69         __s32 value;
  70         __s32 minimum;
  71         __s32 maximum;
  72         __s32 fuzz;
  73         __s32 flat;
  74         __s32 resolution;
  75 };
  76
  77 /**
  78  * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
  79  * @scancode: scancode represented in machine-endian form.
  80  * @len: length of the scancode that resides in @scancode buffer.
  81  * @index: index in the keymap, may be used instead of scancode
  82  * @flags: allows to specify how kernel should handle the request. For
  83  *      example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
  84  *      should perform lookup in keymap by @index instead of @scancode
  85  * @keycode: key code assigned to this scancode
  86  *
  87  * The structure is used to retrieve and modify keymap data. Users have
  88  * option of performing lookup either by @scancode itself or by @index
  89  * in keymap entry. EVIOCGKEYCODE will also return scancode or index
  90  * (depending on which element was used to perform lookup).
  91  */
  92 struct input_keymap_entry {
  93 #define INPUT_KEYMAP_BY_INDEX   (1 << 0)
  94         __u8  flags;
  95         __u8  len;
  96         __u16 index;
  97         __u32 keycode;
  98         __u8  scancode[32];
  99 };
 100
 101 struct input_mask {
 102         __u32 type;
 103         __u32 codes_size;
 104         __u64 codes_ptr;
 105 };
 106
 107 #define EVIOCGVERSION           _IOR('E', 0x01, int)                    /* get driver version */
 108 #define EVIOCGID                _IOR('E', 0x02, struct input_id)        /* get device ID */
 109 #define EVIOCGREP               _IOR('E', 0x03, unsigned int[2])        /* get repeat settings */
 110 #define EVIOCSREP               _IOW('E', 0x03, unsigned int[2])        /* set repeat settings */
 111
 112 #define EVIOCGKEYCODE           _IOR('E', 0x04, unsigned int[2])        /* get keycode */
 113 #define EVIOCGKEYCODE_V2        _IOR('E', 0x04, struct input_keymap_entry)
 114 #define EVIOCSKEYCODE           _IOW('E', 0x04, unsigned int[2])        /* set keycode */
 115 #define EVIOCSKEYCODE_V2        _IOW('E', 0x04, struct input_keymap_entry)
 116
 117 #define EVIOCGNAME(len)         _IOC(_IOC_READ, 'E', 0x06, len)         /* get device name */
 118 #define EVIOCGPHYS(len)         _IOC(_IOC_READ, 'E', 0x07, len)         /* get physical location */
 119 #define EVIOCGUNIQ(len)         _IOC(_IOC_READ, 'E', 0x08, len)         /* get unique identifier */
 120 #define EVIOCGPROP(len)         _IOC(_IOC_READ, 'E', 0x09, len)         /* get device properties */
 121
 122 /**
 123  * EVIOCGMTSLOTS(len) - get MT slot values
 124  * @len: size of the data buffer in bytes
 125  *
 126  * The ioctl buffer argument should be binary equivalent to
 127  *
 128  * struct input_mt_request_layout {
 129  *      __u32 code;
 130  *      __s32 values[num_slots];
 131  * };
 132  *
 133  * where num_slots is the (arbitrary) number of MT slots to extract.
 134  *
 135  * The ioctl size argument (len) is the size of the buffer, which
 136  * should satisfy len = (num_slots + 1) * sizeof(__s32).  If len is
 137  * too small to fit all available slots, the first num_slots are
 138  * returned.
 139  *
 140  * Before the call, code is set to the wanted ABS_MT event type. On
 141  * return, values[] is filled with the slot values for the specified
 142  * ABS_MT code.
 143  *
 144  * If the request code is not an ABS_MT value, -EINVAL is returned.
 145  */
 146 #define EVIOCGMTSLOTS(len)      _IOC(_IOC_READ, 'E', 0x0a, len)
 147
 148 #define EVIOCGKEY(len)          _IOC(_IOC_READ, 'E', 0x18, len)         /* get global key state */
 149 #define EVIOCGLED(len)          _IOC(_IOC_READ, 'E', 0x19, len)         /* get all LEDs */
 150 #define EVIOCGSND(len)          _IOC(_IOC_READ, 'E', 0x1a, len)         /* get all sounds status */
 151 #define EVIOCGSW(len)           _IOC(_IOC_READ, 'E', 0x1b, len)         /* get all switch states */
 152
 153 #define EVIOCGBIT(ev,len)       _IOC(_IOC_READ, 'E', 0x20 + (ev), len)  /* get event bits */
 154 #define EVIOCGABS(abs)          _IOR('E', 0x40 + (abs), struct input_absinfo)   /* get abs value/limits */
 155 #define EVIOCSABS(abs)          _IOW('E', 0xc0 + (abs), struct input_absinfo)   /* set abs value/limits */
 156
 157 #define EVIOCSFF                _IOW('E', 0x80, struct ff_effect)       /* send a force effect to a force feedback device */
 158 #define EVIOCRMFF               _IOW('E', 0x81, int)                    /* Erase a force effect */
 159 #define EVIOCGEFFECTS           _IOR('E', 0x84, int)                    /* Report number of effects playable at the same time */
 160
 161 #define EVIOCGRAB               _IOW('E', 0x90, int)                    /* Grab/Release device */
 162 #define EVIOCREVOKE             _IOW('E', 0x91, int)                    /* Revoke device access */
 163
 164 /**
 165  * EVIOCGMASK - Retrieve current event mask
 166  *
 167  * This ioctl allows user to retrieve the current event mask for specific
 168  * event type. The argument must be of type "struct input_mask" and
 169  * specifies the event type to query, the address of the receive buffer and
 170  * the size of the receive buffer.
 171  *
 172  * The event mask is a per-client mask that specifies which events are
 173  * forwarded to the client. Each event code is represented by a single bit
 174  * in the event mask. If the bit is set, the event is passed to the client
 175  * normally. Otherwise, the event is filtered and will never be queued on
 176  * the client's receive buffer.
 177  *
 178  * Event masks do not affect global state of the input device. They only
 179  * affect the file descriptor they are applied to.
 180  *
 181  * The default event mask for a client has all bits set, i.e. all events
 182  * are forwarded to the client. If the kernel is queried for an unknown
 183  * event type or if the receive buffer is larger than the number of
 184  * event codes known to the kernel, the kernel returns all zeroes for those
 185  * codes.
 186  *
 187  * At maximum, codes_size bytes are copied.
 188  *
 189  * This ioctl may fail with ENODEV in case the file is revoked, EFAULT
 190  * if the receive-buffer points to invalid memory, or EINVAL if the kernel
 191  * does not implement the ioctl.
 192  */
 193 #define EVIOCGMASK              _IOR('E', 0x92, struct input_mask)      /* Get event-masks */
 194
 195 /**
 196  * EVIOCSMASK - Set event mask
 197  *
 198  * This ioctl is the counterpart to EVIOCGMASK. Instead of receiving the
 199  * current event mask, this changes the client's event mask for a specific
 200  * type.  See EVIOCGMASK for a description of event-masks and the
 201  * argument-type.
 202  *
 203  * This ioctl provides full forward compatibility. If the passed event type
 204  * is unknown to the kernel, or if the number of event codes specified in
 205  * the mask is bigger than what is known to the kernel, the ioctl is still
 206  * accepted and applied. However, any unknown codes are left untouched and
 207  * stay cleared. That means, the kernel always filters unknown codes
 208  * regardless of what the client requests.  If the new mask doesn't cover
 209  * all known event-codes, all remaining codes are automatically cleared and
 210  * thus filtered.
 211  *
 212  * This ioctl may fail with ENODEV in case the file is revoked. EFAULT is
 213  * returned if the receive-buffer points to invalid memory. EINVAL is returned
 214  * if the kernel does not implement the ioctl.
 215  */
 216 #define EVIOCSMASK              _IOW('E', 0x93, struct input_mask)      /* Set event-masks */
 217
 218 #define EVIOCSCLOCKID           _IOW('E', 0xa0, int)                    /* Set clockid to be used for timestamps */
 219
 220 /*
 221  * IDs.
 222  */
 223
 224 #define ID_BUS                  0
 225 #define ID_VENDOR               1
 226 #define ID_PRODUCT              2
 227 #define ID_VERSION              3
 228
 229 #define BUS_PCI                 0x01
 230 #define BUS_ISAPNP              0x02
 231 #define BUS_USB                 0x03
 232 #define BUS_HIL                 0x04
 233 #define BUS_BLUETOOTH           0x05
 234 #define BUS_VIRTUAL             0x06
 235
 236 #define BUS_ISA                 0x10
 237 #define BUS_I8042               0x11
 238 #define BUS_XTKBD               0x12
 239 #define BUS_RS232               0x13
 240 #define BUS_GAMEPORT            0x14
 241 #define BUS_PARPORT             0x15
 242 #define BUS_AMIGA               0x16
 243 #define BUS_ADB                 0x17
 244 #define BUS_I2C                 0x18
 245 #define BUS_HOST                0x19
 246 #define BUS_GSC                 0x1A
 247 #define BUS_ATARI               0x1B
 248 #define BUS_SPI                 0x1C
 249 #define BUS_RMI                 0x1D
 250 #define BUS_CEC                 0x1E
 251
 252 /*
 253  * MT_TOOL types
 254  */
 255 #define MT_TOOL_FINGER          0
 256 #define MT_TOOL_PEN             1
 257 #define MT_TOOL_PALM            2
 258 #define MT_TOOL_MAX             2
 259
 260 /*
 261  * Values describing the status of a force-feedback effect
 262  */
 263 #define FF_STATUS_STOPPED       0x00
 264 #define FF_STATUS_PLAYING       0x01
 265 #define FF_STATUS_MAX           0x01
 266
 267 /*
 268  * Structures used in ioctls to upload effects to a device
 269  * They are pieces of a bigger structure (called ff_effect)
 270  */
 271
 272 /*
 273  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
 274  * should not be used and have unspecified results.
 275  */
 276
 277 /**
 278  * struct ff_replay - defines scheduling of the force-feedback effect
 279  * @length: duration of the effect
 280  * @delay: delay before effect should start playing
 281  */
 282 struct ff_replay {
 283         __u16 length;
 284         __u16 delay;
 285 };
 286
 287 /**
 288  * struct ff_trigger - defines what triggers the force-feedback effect
 289  * @button: number of the button triggering the effect
 290  * @interval: controls how soon the effect can be re-triggered
 291  */
 292 struct ff_trigger {
 293         __u16 button;
 294         __u16 interval;
 295 };
 296
 297 /**
 298  * struct ff_envelope - generic force-feedback effect envelope
 299  * @attack_length: duration of the attack (ms)
 300  * @attack_level: level at the beginning of the attack
 301  * @fade_length: duration of fade (ms)
 302  * @fade_level: level at the end of fade
 303  *
 304  * The @attack_level and @fade_level are absolute values; when applying
 305  * envelope force-feedback core will convert to positive/negative
 306  * value based on polarity of the default level of the effect.
 307  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
 308  */
 309 struct ff_envelope {
 310         __u16 attack_length;
 311         __u16 attack_level;
 312         __u16 fade_length;
 313         __u16 fade_level;
 314 };
 315
 316 /**
 317  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
 318  * @level: strength of the effect; may be negative
 319  * @envelope: envelope data
 320  */
 321 struct ff_constant_effect {
 322         __s16 level;
 323         struct ff_envelope envelope;
 324 };
 325
 326 /**
 327  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
 328  * @start_level: beginning strength of the effect; may be negative
 329  * @end_level: final strength of the effect; may be negative
 330  * @envelope: envelope data
 331  */
 332 struct ff_ramp_effect {
 333         __s16 start_level;
 334         __s16 end_level;
 335         struct ff_envelope envelope;
 336 };
 337
 338 /**
 339  * struct ff_condition_effect - defines a spring or friction force-feedback effect
 340  * @right_saturation: maximum level when joystick moved all way to the right
 341  * @left_saturation: same for the left side
 342  * @right_coeff: controls how fast the force grows when the joystick moves
 343  *      to the right
 344  * @left_coeff: same for the left side
 345  * @deadband: size of the dead zone, where no force is produced
 346  * @center: position of the dead zone
 347  */
 348 struct ff_condition_effect {
 349         __u16 right_saturation;
 350         __u16 left_saturation;
 351
 352         __s16 right_coeff;
 353         __s16 left_coeff;
 354
 355         __u16 deadband;
 356         __s16 center;
 357 };
 358
 359 /**
 360  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
 361  * @waveform: kind of the effect (wave)
 362  * @period: period of the wave (ms)
 363  * @magnitude: peak value
 364  * @offset: mean value of the wave (roughly)
 365  * @phase: 'horizontal' shift
 366  * @envelope: envelope data
 367  * @custom_len: number of samples (FF_CUSTOM only)
 368  * @custom_data: buffer of samples (FF_CUSTOM only)
 369  *
 370  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
 371  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
 372  * for the time being as no driver supports it yet.
 373  *
 374  * Note: the data pointed by custom_data is copied by the driver.
 375  * You can therefore dispose of the memory after the upload/update.
 376  */
 377 struct ff_periodic_effect {
 378         __u16 waveform;
 379         __u16 period;
 380         __s16 magnitude;
 381         __s16 offset;
 382         __u16 phase;
 383
 384         struct ff_envelope envelope;
 385
 386         __u32 custom_len;
 387         __s16 __user *custom_data;
 388 };
 389
 390 /**
 391  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
 392  * @strong_magnitude: magnitude of the heavy motor
 393  * @weak_magnitude: magnitude of the light one
 394  *
 395  * Some rumble pads have two motors of different weight. Strong_magnitude
 396  * represents the magnitude of the vibration generated by the heavy one.
 397  */
 398 struct ff_rumble_effect {
 399         __u16 strong_magnitude;
 400         __u16 weak_magnitude;
 401 };
 402
 403 /**
 404  * struct ff_effect - defines force feedback effect
 405  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
 406  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
 407  * @id: an unique id assigned to an effect
 408  * @direction: direction of the effect
 409  * @trigger: trigger conditions (struct ff_trigger)
 410  * @replay: scheduling of the effect (struct ff_replay)
 411  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
 412  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
 413  *      defining effect parameters
 414  *
 415  * This structure is sent through ioctl from the application to the driver.
 416  * To create a new effect application should set its @id to -1; the kernel
 417  * will return assigned @id which can later be used to update or delete
 418  * this effect.
 419  *
 420  * Direction of the effect is encoded as follows:
 421  *      0 deg -> 0x0000 (down)
 422  *      90 deg -> 0x4000 (left)
 423  *      180 deg -> 0x8000 (up)
 424  *      270 deg -> 0xC000 (right)
 425  */
 426 struct ff_effect {
 427         __u16 type;
 428         __s16 id;
 429         __u16 direction;
 430         struct ff_trigger trigger;
 431         struct ff_replay replay;
 432
 433         union {
 434                 struct ff_constant_effect constant;
 435                 struct ff_ramp_effect ramp;
 436                 struct ff_periodic_effect periodic;
 437                 struct ff_condition_effect condition[2]; /* One for each axis */
 438                 struct ff_rumble_effect rumble;
 439         } u;
 440 };
 441
 442 /*
 443  * Force feedback effect types
 444  */
 445
 446 #define FF_RUMBLE       0x50
 447 #define FF_PERIODIC     0x51
 448 #define FF_CONSTANT     0x52
 449 #define FF_SPRING       0x53
 450 #define FF_FRICTION     0x54
 451 #define FF_DAMPER       0x55
 452 #define FF_INERTIA      0x56
 453 #define FF_RAMP         0x57
 454
 455 #define FF_EFFECT_MIN   FF_RUMBLE
 456 #define FF_EFFECT_MAX   FF_RAMP
 457
 458 /*
 459  * Force feedback periodic effect types
 460  */
 461
 462 #define FF_SQUARE       0x58
 463 #define FF_TRIANGLE     0x59
 464 #define FF_SINE         0x5a
 465 #define FF_SAW_UP       0x5b
 466 #define FF_SAW_DOWN     0x5c
 467 #define FF_CUSTOM       0x5d
 468
 469 #define FF_WAVEFORM_MIN FF_SQUARE
 470 #define FF_WAVEFORM_MAX FF_CUSTOM
 471
 472 /*
 473  * Set ff device properties
 474  */
 475
 476 #define FF_GAIN         0x60
 477 #define FF_AUTOCENTER   0x61
 478
 479 /*
 480  * ff->playback(effect_id = FF_GAIN) is the first effect_id to
 481  * cause a collision with another ff method, in this case ff->set_gain().
 482  * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
 483  * and thus the total number of effects should never exceed FF_GAIN.
 484  */
 485 #define FF_MAX_EFFECTS  FF_GAIN
 486
 487 #define FF_MAX          0x7f
 488 #define FF_CNT          (FF_MAX+1)
 489
 490 #endif /* _UAPI_INPUT_H */