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