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