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