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