include/standard-headers/linux/input.h

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