1 #ifndef _INPUT_H 2 #define _INPUT_H 3 4 /* 5 * Copyright (c) 1999-2002 Vojtech Pavlik 6 * 7 * This program is free software; you can redistribute it and/or modify it 8 * under the terms of the GNU General Public License version 2 as published by 9 * the Free Software Foundation. 10 */ 11 12 #ifdef __KERNEL__ 13 #include <linux/time.h> 14 #include <linux/list.h> 15 #else 16 #include <sys/time.h> 17 #include <sys/ioctl.h> 18 #include <sys/types.h> 19 #include <linux/types.h> 20 #endif 21 22 /* 23 * The event structure itself 24 */ 25 26 struct input_event { 27 struct timeval time; 28 __u16 type; 29 __u16 code; 30 __s32 value; 31 }; 32 33 /* 34 * Protocol version. 35 */ 36 37 #define EV_VERSION 0x010001 38 39 /* 40 * IOCTLs (0x00 - 0x7f) 41 */ 42 43 struct input_id { 44 __u16 bustype; 45 __u16 vendor; 46 __u16 product; 47 __u16 version; 48 }; 49 50 /** 51 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls 52 * @value: latest reported value for the axis. 53 * @minimum: specifies minimum value for the axis. 54 * @maximum: specifies maximum value for the axis. 55 * @fuzz: specifies fuzz value that is used to filter noise from 56 * the event stream. 57 * @flat: values that are within this value will be discarded by 58 * joydev interface and reported as 0 instead. 59 * @resolution: specifies resolution for the values reported for 60 * the axis. 61 * 62 * Note that input core does not clamp reported values to the 63 * [minimum, maximum] limits, such task is left to userspace. 64 * 65 * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in 66 * units per millimeter (units/mm), resolution for rotational axes 67 * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian. 68 */ 69 struct input_absinfo { 70 __s32 value; 71 __s32 minimum; 72 __s32 maximum; 73 __s32 fuzz; 74 __s32 flat; 75 __s32 resolution; 76 }; 77 78 /** 79 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls 80 * @scancode: scancode represented in machine-endian form. 81 * @len: length of the scancode that resides in @scancode buffer. 82 * @index: index in the keymap, may be used instead of scancode 83 * @flags: allows to specify how kernel should handle the request. For 84 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel 85 * should perform lookup in keymap by @index instead of @scancode 86 * @keycode: key code assigned to this scancode 87 * 88 * The structure is used to retrieve and modify keymap data. Users have 89 * option of performing lookup either by @scancode itself or by @index 90 * in keymap entry. EVIOCGKEYCODE will also return scancode or index 91 * (depending on which element was used to perform lookup). 92 */ 93 struct input_keymap_entry { 94 #define INPUT_KEYMAP_BY_INDEX (1 << 0) 95 __u8 flags; 96 __u8 len; 97 __u16 index; 98 __u32 keycode; 99 __u8 scancode[32]; 100 }; 101 102 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */ 103 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */ 104 #define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */ 105 #define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */ 106 107 #define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */ 108 #define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry) 109 #define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */ 110 #define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry) 111 112 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */ 113 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */ 114 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */ 115 #define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */ 116 117 /** 118 * EVIOCGMTSLOTS(len) - get MT slot values 119 * 120 * The ioctl buffer argument should be binary equivalent to 121 * 122 * struct input_mt_request_layout { 123 * __u32 code; 124 * __s32 values[num_slots]; 125 * }; 126 * 127 * where num_slots is the (arbitrary) number of MT slots to extract. 128 * 129 * The ioctl size argument (len) is the size of the buffer, which 130 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is 131 * too small to fit all available slots, the first num_slots are 132 * returned. 133 * 134 * Before the call, code is set to the wanted ABS_MT event type. On 135 * return, values[] is filled with the slot values for the specified 136 * ABS_MT code. 137 * 138 * If the request code is not an ABS_MT value, -EINVAL is returned. 139 */ 140 #define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len) 141 142 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */ 143 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */ 144 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */ 145 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */ 146 147 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */ 148 #define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */ 149 #define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */ 150 151 #define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */ 152 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */ 153 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */ 154 155 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */ 156 157 #define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */ 158 159 /* 160 * Device properties and quirks 161 */ 162 163 #define INPUT_PROP_POINTER 0x00 /* needs a pointer */ 164 #define INPUT_PROP_DIRECT 0x01 /* direct input devices */ 165 #define INPUT_PROP_BUTTONPAD 0x02 /* has button(s) under pad */ 166 #define INPUT_PROP_SEMI_MT 0x03 /* touch rectangle only */ 167 168 #define INPUT_PROP_MAX 0x1f 169 #define INPUT_PROP_CNT (INPUT_PROP_MAX + 1) 170 171 /* 172 * Event types 173 */ 174 175 #define EV_SYN 0x00 176 #define EV_KEY 0x01 177 #define EV_REL 0x02 178 #define EV_ABS 0x03 179 #define EV_MSC 0x04 180 #define EV_SW 0x05 181 #define EV_LED 0x11 182 #define EV_SND 0x12 183 #define EV_REP 0x14 184 #define EV_FF 0x15 185 #define EV_PWR 0x16 186 #define EV_FF_STATUS 0x17 187 #define EV_MAX 0x1f 188 #define EV_CNT (EV_MAX+1) 189 190 /* 191 * Synchronization events. 192 */ 193 194 #define SYN_REPORT 0 195 #define SYN_CONFIG 1 196 #define SYN_MT_REPORT 2 197 #define SYN_DROPPED 3 198 199 /* 200 * Keys and buttons 201 * 202 * Most of the keys/buttons are modeled after USB HUT 1.12 203 * (see http://www.usb.org/developers/hidpage). 204 * Abbreviations in the comments: 205 * AC - Application Control 206 * AL - Application Launch Button 207 * SC - System Control 208 */ 209 210 #define KEY_RESERVED 0 211 #define KEY_ESC 1 212 #define KEY_1 2 213 #define KEY_2 3 214 #define KEY_3 4 215 #define KEY_4 5 216 #define KEY_5 6 217 #define KEY_6 7 218 #define KEY_7 8 219 #define KEY_8 9 220 #define KEY_9 10 221 #define KEY_0 11 222 #define KEY_MINUS 12 223 #define KEY_EQUAL 13 224 #define KEY_BACKSPACE 14 225 #define KEY_TAB 15 226 #define KEY_Q 16 227 #define KEY_W 17 228 #define KEY_E 18 229 #define KEY_R 19 230 #define KEY_T 20 231 #define KEY_Y 21 232 #define KEY_U 22 233 #define KEY_I 23 234 #define KEY_O 24 235 #define KEY_P 25 236 #define KEY_LEFTBRACE 26 237 #define KEY_RIGHTBRACE 27 238 #define KEY_ENTER 28 239 #define KEY_LEFTCTRL 29 240 #define KEY_A 30 241 #define KEY_S 31 242 #define KEY_D 32 243 #define KEY_F 33 244 #define KEY_G 34 245 #define KEY_H 35 246 #define KEY_J 36 247 #define KEY_K 37 248 #define KEY_L 38 249 #define KEY_SEMICOLON 39 250 #define KEY_APOSTROPHE 40 251 #define KEY_GRAVE 41 252 #define KEY_LEFTSHIFT 42 253 #define KEY_BACKSLASH 43 254 #define KEY_Z 44 255 #define KEY_X 45 256 #define KEY_C 46 257 #define KEY_V 47 258 #define KEY_B 48 259 #define KEY_N 49 260 #define KEY_M 50 261 #define KEY_COMMA 51 262 #define KEY_DOT 52 263 #define KEY_SLASH 53 264 #define KEY_RIGHTSHIFT 54 265 #define KEY_KPASTERISK 55 266 #define KEY_LEFTALT 56 267 #define KEY_SPACE 57 268 #define KEY_CAPSLOCK 58 269 #define KEY_F1 59 270 #define KEY_F2 60 271 #define KEY_F3 61 272 #define KEY_F4 62 273 #define KEY_F5 63 274 #define KEY_F6 64 275 #define KEY_F7 65 276 #define KEY_F8 66 277 #define KEY_F9 67 278 #define KEY_F10 68 279 #define KEY_NUMLOCK 69 280 #define KEY_SCROLLLOCK 70 281 #define KEY_KP7 71 282 #define KEY_KP8 72 283 #define KEY_KP9 73 284 #define KEY_KPMINUS 74 285 #define KEY_KP4 75 286 #define KEY_KP5 76 287 #define KEY_KP6 77 288 #define KEY_KPPLUS 78 289 #define KEY_KP1 79 290 #define KEY_KP2 80 291 #define KEY_KP3 81 292 #define KEY_KP0 82 293 #define KEY_KPDOT 83 294 295 #define KEY_ZENKAKUHANKAKU 85 296 #define KEY_102ND 86 297 #define KEY_F11 87 298 #define KEY_F12 88 299 #define KEY_RO 89 300 #define KEY_KATAKANA 90 301 #define KEY_HIRAGANA 91 302 #define KEY_HENKAN 92 303 #define KEY_KATAKANAHIRAGANA 93 304 #define KEY_MUHENKAN 94 305 #define KEY_KPJPCOMMA 95 306 #define KEY_KPENTER 96 307 #define KEY_RIGHTCTRL 97 308 #define KEY_KPSLASH 98 309 #define KEY_SYSRQ 99 310 #define KEY_RIGHTALT 100 311 #define KEY_LINEFEED 101 312 #define KEY_HOME 102 313 #define KEY_UP 103 314 #define KEY_PAGEUP 104 315 #define KEY_LEFT 105 316 #define KEY_RIGHT 106 317 #define KEY_END 107 318 #define KEY_DOWN 108 319 #define KEY_PAGEDOWN 109 320 #define KEY_INSERT 110 321 #define KEY_DELETE 111 322 #define KEY_MACRO 112 323 #define KEY_MUTE 113 324 #define KEY_VOLUMEDOWN 114 325 #define KEY_VOLUMEUP 115 326 #define KEY_POWER 116 /* SC System Power Down */ 327 #define KEY_KPEQUAL 117 328 #define KEY_KPPLUSMINUS 118 329 #define KEY_PAUSE 119 330 #define KEY_SCALE 120 /* AL Compiz Scale (Expose) */ 331 332 #define KEY_KPCOMMA 121 333 #define KEY_HANGEUL 122 334 #define KEY_HANGUEL KEY_HANGEUL 335 #define KEY_HANJA 123 336 #define KEY_YEN 124 337 #define KEY_LEFTMETA 125 338 #define KEY_RIGHTMETA 126 339 #define KEY_COMPOSE 127 340 341 #define KEY_STOP 128 /* AC Stop */ 342 #define KEY_AGAIN 129 343 #define KEY_PROPS 130 /* AC Properties */ 344 #define KEY_UNDO 131 /* AC Undo */ 345 #define KEY_FRONT 132 346 #define KEY_COPY 133 /* AC Copy */ 347 #define KEY_OPEN 134 /* AC Open */ 348 #define KEY_PASTE 135 /* AC Paste */ 349 #define KEY_FIND 136 /* AC Search */ 350 #define KEY_CUT 137 /* AC Cut */ 351 #define KEY_HELP 138 /* AL Integrated Help Center */ 352 #define KEY_MENU 139 /* Menu (show menu) */ 353 #define KEY_CALC 140 /* AL Calculator */ 354 #define KEY_SETUP 141 355 #define KEY_SLEEP 142 /* SC System Sleep */ 356 #define KEY_WAKEUP 143 /* System Wake Up */ 357 #define KEY_FILE 144 /* AL Local Machine Browser */ 358 #define KEY_SENDFILE 145 359 #define KEY_DELETEFILE 146 360 #define KEY_XFER 147 361 #define KEY_PROG1 148 362 #define KEY_PROG2 149 363 #define KEY_WWW 150 /* AL Internet Browser */ 364 #define KEY_MSDOS 151 365 #define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */ 366 #define KEY_SCREENLOCK KEY_COFFEE 367 #define KEY_DIRECTION 153 368 #define KEY_CYCLEWINDOWS 154 369 #define KEY_MAIL 155 370 #define KEY_BOOKMARKS 156 /* AC Bookmarks */ 371 #define KEY_COMPUTER 157 372 #define KEY_BACK 158 /* AC Back */ 373 #define KEY_FORWARD 159 /* AC Forward */ 374 #define KEY_CLOSECD 160 375 #define KEY_EJECTCD 161 376 #define KEY_EJECTCLOSECD 162 377 #define KEY_NEXTSONG 163 378 #define KEY_PLAYPAUSE 164 379 #define KEY_PREVIOUSSONG 165 380 #define KEY_STOPCD 166 381 #define KEY_RECORD 167 382 #define KEY_REWIND 168 383 #define KEY_PHONE 169 /* Media Select Telephone */ 384 #define KEY_ISO 170 385 #define KEY_CONFIG 171 /* AL Consumer Control Configuration */ 386 #define KEY_HOMEPAGE 172 /* AC Home */ 387 #define KEY_REFRESH 173 /* AC Refresh */ 388 #define KEY_EXIT 174 /* AC Exit */ 389 #define KEY_MOVE 175 390 #define KEY_EDIT 176 391 #define KEY_SCROLLUP 177 392 #define KEY_SCROLLDOWN 178 393 #define KEY_KPLEFTPAREN 179 394 #define KEY_KPRIGHTPAREN 180 395 #define KEY_NEW 181 /* AC New */ 396 #define KEY_REDO 182 /* AC Redo/Repeat */ 397 398 #define KEY_F13 183 399 #define KEY_F14 184 400 #define KEY_F15 185 401 #define KEY_F16 186 402 #define KEY_F17 187 403 #define KEY_F18 188 404 #define KEY_F19 189 405 #define KEY_F20 190 406 #define KEY_F21 191 407 #define KEY_F22 192 408 #define KEY_F23 193 409 #define KEY_F24 194 410 411 #define KEY_PLAYCD 200 412 #define KEY_PAUSECD 201 413 #define KEY_PROG3 202 414 #define KEY_PROG4 203 415 #define KEY_DASHBOARD 204 /* AL Dashboard */ 416 #define KEY_SUSPEND 205 417 #define KEY_CLOSE 206 /* AC Close */ 418 #define KEY_PLAY 207 419 #define KEY_FASTFORWARD 208 420 #define KEY_BASSBOOST 209 421 #define KEY_PRINT 210 /* AC Print */ 422 #define KEY_HP 211 423 #define KEY_CAMERA 212 424 #define KEY_SOUND 213 425 #define KEY_QUESTION 214 426 #define KEY_EMAIL 215 427 #define KEY_CHAT 216 428 #define KEY_SEARCH 217 429 #define KEY_CONNECT 218 430 #define KEY_FINANCE 219 /* AL Checkbook/Finance */ 431 #define KEY_SPORT 220 432 #define KEY_SHOP 221 433 #define KEY_ALTERASE 222 434 #define KEY_CANCEL 223 /* AC Cancel */ 435 #define KEY_BRIGHTNESSDOWN 224 436 #define KEY_BRIGHTNESSUP 225 437 #define KEY_MEDIA 226 438 439 #define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video 440 outputs (Monitor/LCD/TV-out/etc) */ 441 #define KEY_KBDILLUMTOGGLE 228 442 #define KEY_KBDILLUMDOWN 229 443 #define KEY_KBDILLUMUP 230 444 445 #define KEY_SEND 231 /* AC Send */ 446 #define KEY_REPLY 232 /* AC Reply */ 447 #define KEY_FORWARDMAIL 233 /* AC Forward Msg */ 448 #define KEY_SAVE 234 /* AC Save */ 449 #define KEY_DOCUMENTS 235 450 451 #define KEY_BATTERY 236 452 453 #define KEY_BLUETOOTH 237 454 #define KEY_WLAN 238 455 #define KEY_UWB 239 456 457 #define KEY_UNKNOWN 240 458 459 #define KEY_VIDEO_NEXT 241 /* drive next video source */ 460 #define KEY_VIDEO_PREV 242 /* drive previous video source */ 461 #define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */ 462 #define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */ 463 #define KEY_DISPLAY_OFF 245 /* display device to off state */ 464 465 #define KEY_WIMAX 246 466 #define KEY_RFKILL 247 /* Key that controls all radios */ 467 468 #define KEY_MICMUTE 248 /* Mute / unmute the microphone */ 469 470 /* Code 255 is reserved for special needs of AT keyboard driver */ 471 472 #define BTN_MISC 0x100 473 #define BTN_0 0x100 474 #define BTN_1 0x101 475 #define BTN_2 0x102 476 #define BTN_3 0x103 477 #define BTN_4 0x104 478 #define BTN_5 0x105 479 #define BTN_6 0x106 480 #define BTN_7 0x107 481 #define BTN_8 0x108 482 #define BTN_9 0x109 483 484 #define BTN_MOUSE 0x110 485 #define BTN_LEFT 0x110 486 #define BTN_RIGHT 0x111 487 #define BTN_MIDDLE 0x112 488 #define BTN_SIDE 0x113 489 #define BTN_EXTRA 0x114 490 #define BTN_FORWARD 0x115 491 #define BTN_BACK 0x116 492 #define BTN_TASK 0x117 493 494 #define BTN_JOYSTICK 0x120 495 #define BTN_TRIGGER 0x120 496 #define BTN_THUMB 0x121 497 #define BTN_THUMB2 0x122 498 #define BTN_TOP 0x123 499 #define BTN_TOP2 0x124 500 #define BTN_PINKIE 0x125 501 #define BTN_BASE 0x126 502 #define BTN_BASE2 0x127 503 #define BTN_BASE3 0x128 504 #define BTN_BASE4 0x129 505 #define BTN_BASE5 0x12a 506 #define BTN_BASE6 0x12b 507 #define BTN_DEAD 0x12f 508 509 #define BTN_GAMEPAD 0x130 510 #define BTN_A 0x130 511 #define BTN_B 0x131 512 #define BTN_C 0x132 513 #define BTN_X 0x133 514 #define BTN_Y 0x134 515 #define BTN_Z 0x135 516 #define BTN_TL 0x136 517 #define BTN_TR 0x137 518 #define BTN_TL2 0x138 519 #define BTN_TR2 0x139 520 #define BTN_SELECT 0x13a 521 #define BTN_START 0x13b 522 #define BTN_MODE 0x13c 523 #define BTN_THUMBL 0x13d 524 #define BTN_THUMBR 0x13e 525 526 #define BTN_DIGI 0x140 527 #define BTN_TOOL_PEN 0x140 528 #define BTN_TOOL_RUBBER 0x141 529 #define BTN_TOOL_BRUSH 0x142 530 #define BTN_TOOL_PENCIL 0x143 531 #define BTN_TOOL_AIRBRUSH 0x144 532 #define BTN_TOOL_FINGER 0x145 533 #define BTN_TOOL_MOUSE 0x146 534 #define BTN_TOOL_LENS 0x147 535 #define BTN_TOOL_QUINTTAP 0x148 /* Five fingers on trackpad */ 536 #define BTN_TOUCH 0x14a 537 #define BTN_STYLUS 0x14b 538 #define BTN_STYLUS2 0x14c 539 #define BTN_TOOL_DOUBLETAP 0x14d 540 #define BTN_TOOL_TRIPLETAP 0x14e 541 #define BTN_TOOL_QUADTAP 0x14f /* Four fingers on trackpad */ 542 543 #define BTN_WHEEL 0x150 544 #define BTN_GEAR_DOWN 0x150 545 #define BTN_GEAR_UP 0x151 546 547 #define KEY_OK 0x160 548 #define KEY_SELECT 0x161 549 #define KEY_GOTO 0x162 550 #define KEY_CLEAR 0x163 551 #define KEY_POWER2 0x164 552 #define KEY_OPTION 0x165 553 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */ 554 #define KEY_TIME 0x167 555 #define KEY_VENDOR 0x168 556 #define KEY_ARCHIVE 0x169 557 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */ 558 #define KEY_CHANNEL 0x16b 559 #define KEY_FAVORITES 0x16c 560 #define KEY_EPG 0x16d 561 #define KEY_PVR 0x16e /* Media Select Home */ 562 #define KEY_MHP 0x16f 563 #define KEY_LANGUAGE 0x170 564 #define KEY_TITLE 0x171 565 #define KEY_SUBTITLE 0x172 566 #define KEY_ANGLE 0x173 567 #define KEY_ZOOM 0x174 568 #define KEY_MODE 0x175 569 #define KEY_KEYBOARD 0x176 570 #define KEY_SCREEN 0x177 571 #define KEY_PC 0x178 /* Media Select Computer */ 572 #define KEY_TV 0x179 /* Media Select TV */ 573 #define KEY_TV2 0x17a /* Media Select Cable */ 574 #define KEY_VCR 0x17b /* Media Select VCR */ 575 #define KEY_VCR2 0x17c /* VCR Plus */ 576 #define KEY_SAT 0x17d /* Media Select Satellite */ 577 #define KEY_SAT2 0x17e 578 #define KEY_CD 0x17f /* Media Select CD */ 579 #define KEY_TAPE 0x180 /* Media Select Tape */ 580 #define KEY_RADIO 0x181 581 #define KEY_TUNER 0x182 /* Media Select Tuner */ 582 #define KEY_PLAYER 0x183 583 #define KEY_TEXT 0x184 584 #define KEY_DVD 0x185 /* Media Select DVD */ 585 #define KEY_AUX 0x186 586 #define KEY_MP3 0x187 587 #define KEY_AUDIO 0x188 /* AL Audio Browser */ 588 #define KEY_VIDEO 0x189 /* AL Movie Browser */ 589 #define KEY_DIRECTORY 0x18a 590 #define KEY_LIST 0x18b 591 #define KEY_MEMO 0x18c /* Media Select Messages */ 592 #define KEY_CALENDAR 0x18d 593 #define KEY_RED 0x18e 594 #define KEY_GREEN 0x18f 595 #define KEY_YELLOW 0x190 596 #define KEY_BLUE 0x191 597 #define KEY_CHANNELUP 0x192 /* Channel Increment */ 598 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */ 599 #define KEY_FIRST 0x194 600 #define KEY_LAST 0x195 /* Recall Last */ 601 #define KEY_AB 0x196 602 #define KEY_NEXT 0x197 603 #define KEY_RESTART 0x198 604 #define KEY_SLOW 0x199 605 #define KEY_SHUFFLE 0x19a 606 #define KEY_BREAK 0x19b 607 #define KEY_PREVIOUS 0x19c 608 #define KEY_DIGITS 0x19d 609 #define KEY_TEEN 0x19e 610 #define KEY_TWEN 0x19f 611 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */ 612 #define KEY_GAMES 0x1a1 /* Media Select Games */ 613 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */ 614 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */ 615 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */ 616 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */ 617 #define KEY_EDITOR 0x1a6 /* AL Text Editor */ 618 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */ 619 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */ 620 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */ 621 #define KEY_DATABASE 0x1aa /* AL Database App */ 622 #define KEY_NEWS 0x1ab /* AL Newsreader */ 623 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */ 624 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */ 625 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */ 626 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */ 627 #define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */ 628 #define KEY_LOGOFF 0x1b1 /* AL Logoff */ 629 630 #define KEY_DOLLAR 0x1b2 631 #define KEY_EURO 0x1b3 632 633 #define KEY_FRAMEBACK 0x1b4 /* Consumer - transport controls */ 634 #define KEY_FRAMEFORWARD 0x1b5 635 #define KEY_CONTEXT_MENU 0x1b6 /* GenDesc - system context menu */ 636 #define KEY_MEDIA_REPEAT 0x1b7 /* Consumer - transport control */ 637 #define KEY_10CHANNELSUP 0x1b8 /* 10 channels up (10+) */ 638 #define KEY_10CHANNELSDOWN 0x1b9 /* 10 channels down (10-) */ 639 #define KEY_IMAGES 0x1ba /* AL Image Browser */ 640 641 #define KEY_DEL_EOL 0x1c0 642 #define KEY_DEL_EOS 0x1c1 643 #define KEY_INS_LINE 0x1c2 644 #define KEY_DEL_LINE 0x1c3 645 646 #define KEY_FN 0x1d0 647 #define KEY_FN_ESC 0x1d1 648 #define KEY_FN_F1 0x1d2 649 #define KEY_FN_F2 0x1d3 650 #define KEY_FN_F3 0x1d4 651 #define KEY_FN_F4 0x1d5 652 #define KEY_FN_F5 0x1d6 653 #define KEY_FN_F6 0x1d7 654 #define KEY_FN_F7 0x1d8 655 #define KEY_FN_F8 0x1d9 656 #define KEY_FN_F9 0x1da 657 #define KEY_FN_F10 0x1db 658 #define KEY_FN_F11 0x1dc 659 #define KEY_FN_F12 0x1dd 660 #define KEY_FN_1 0x1de 661 #define KEY_FN_2 0x1df 662 #define KEY_FN_D 0x1e0 663 #define KEY_FN_E 0x1e1 664 #define KEY_FN_F 0x1e2 665 #define KEY_FN_S 0x1e3 666 #define KEY_FN_B 0x1e4 667 668 #define KEY_BRL_DOT1 0x1f1 669 #define KEY_BRL_DOT2 0x1f2 670 #define KEY_BRL_DOT3 0x1f3 671 #define KEY_BRL_DOT4 0x1f4 672 #define KEY_BRL_DOT5 0x1f5 673 #define KEY_BRL_DOT6 0x1f6 674 #define KEY_BRL_DOT7 0x1f7 675 #define KEY_BRL_DOT8 0x1f8 676 #define KEY_BRL_DOT9 0x1f9 677 #define KEY_BRL_DOT10 0x1fa 678 679 #define KEY_NUMERIC_0 0x200 /* used by phones, remote controls, */ 680 #define KEY_NUMERIC_1 0x201 /* and other keypads */ 681 #define KEY_NUMERIC_2 0x202 682 #define KEY_NUMERIC_3 0x203 683 #define KEY_NUMERIC_4 0x204 684 #define KEY_NUMERIC_5 0x205 685 #define KEY_NUMERIC_6 0x206 686 #define KEY_NUMERIC_7 0x207 687 #define KEY_NUMERIC_8 0x208 688 #define KEY_NUMERIC_9 0x209 689 #define KEY_NUMERIC_STAR 0x20a 690 #define KEY_NUMERIC_POUND 0x20b 691 692 #define KEY_CAMERA_FOCUS 0x210 693 #define KEY_WPS_BUTTON 0x211 /* WiFi Protected Setup key */ 694 695 #define KEY_TOUCHPAD_TOGGLE 0x212 /* Request switch touchpad on or off */ 696 #define KEY_TOUCHPAD_ON 0x213 697 #define KEY_TOUCHPAD_OFF 0x214 698 699 #define KEY_CAMERA_ZOOMIN 0x215 700 #define KEY_CAMERA_ZOOMOUT 0x216 701 #define KEY_CAMERA_UP 0x217 702 #define KEY_CAMERA_DOWN 0x218 703 #define KEY_CAMERA_LEFT 0x219 704 #define KEY_CAMERA_RIGHT 0x21a 705 706 #define BTN_TRIGGER_HAPPY 0x2c0 707 #define BTN_TRIGGER_HAPPY1 0x2c0 708 #define BTN_TRIGGER_HAPPY2 0x2c1 709 #define BTN_TRIGGER_HAPPY3 0x2c2 710 #define BTN_TRIGGER_HAPPY4 0x2c3 711 #define BTN_TRIGGER_HAPPY5 0x2c4 712 #define BTN_TRIGGER_HAPPY6 0x2c5 713 #define BTN_TRIGGER_HAPPY7 0x2c6 714 #define BTN_TRIGGER_HAPPY8 0x2c7 715 #define BTN_TRIGGER_HAPPY9 0x2c8 716 #define BTN_TRIGGER_HAPPY10 0x2c9 717 #define BTN_TRIGGER_HAPPY11 0x2ca 718 #define BTN_TRIGGER_HAPPY12 0x2cb 719 #define BTN_TRIGGER_HAPPY13 0x2cc 720 #define BTN_TRIGGER_HAPPY14 0x2cd 721 #define BTN_TRIGGER_HAPPY15 0x2ce 722 #define BTN_TRIGGER_HAPPY16 0x2cf 723 #define BTN_TRIGGER_HAPPY17 0x2d0 724 #define BTN_TRIGGER_HAPPY18 0x2d1 725 #define BTN_TRIGGER_HAPPY19 0x2d2 726 #define BTN_TRIGGER_HAPPY20 0x2d3 727 #define BTN_TRIGGER_HAPPY21 0x2d4 728 #define BTN_TRIGGER_HAPPY22 0x2d5 729 #define BTN_TRIGGER_HAPPY23 0x2d6 730 #define BTN_TRIGGER_HAPPY24 0x2d7 731 #define BTN_TRIGGER_HAPPY25 0x2d8 732 #define BTN_TRIGGER_HAPPY26 0x2d9 733 #define BTN_TRIGGER_HAPPY27 0x2da 734 #define BTN_TRIGGER_HAPPY28 0x2db 735 #define BTN_TRIGGER_HAPPY29 0x2dc 736 #define BTN_TRIGGER_HAPPY30 0x2dd 737 #define BTN_TRIGGER_HAPPY31 0x2de 738 #define BTN_TRIGGER_HAPPY32 0x2df 739 #define BTN_TRIGGER_HAPPY33 0x2e0 740 #define BTN_TRIGGER_HAPPY34 0x2e1 741 #define BTN_TRIGGER_HAPPY35 0x2e2 742 #define BTN_TRIGGER_HAPPY36 0x2e3 743 #define BTN_TRIGGER_HAPPY37 0x2e4 744 #define BTN_TRIGGER_HAPPY38 0x2e5 745 #define BTN_TRIGGER_HAPPY39 0x2e6 746 #define BTN_TRIGGER_HAPPY40 0x2e7 747 748 /* We avoid low common keys in module aliases so they don't get huge. */ 749 #define KEY_MIN_INTERESTING KEY_MUTE 750 #define KEY_MAX 0x2ff 751 #define KEY_CNT (KEY_MAX+1) 752 753 /* 754 * Relative axes 755 */ 756 757 #define REL_X 0x00 758 #define REL_Y 0x01 759 #define REL_Z 0x02 760 #define REL_RX 0x03 761 #define REL_RY 0x04 762 #define REL_RZ 0x05 763 #define REL_HWHEEL 0x06 764 #define REL_DIAL 0x07 765 #define REL_WHEEL 0x08 766 #define REL_MISC 0x09 767 #define REL_MAX 0x0f 768 #define REL_CNT (REL_MAX+1) 769 770 /* 771 * Absolute axes 772 */ 773 774 #define ABS_X 0x00 775 #define ABS_Y 0x01 776 #define ABS_Z 0x02 777 #define ABS_RX 0x03 778 #define ABS_RY 0x04 779 #define ABS_RZ 0x05 780 #define ABS_THROTTLE 0x06 781 #define ABS_RUDDER 0x07 782 #define ABS_WHEEL 0x08 783 #define ABS_GAS 0x09 784 #define ABS_BRAKE 0x0a 785 #define ABS_HAT0X 0x10 786 #define ABS_HAT0Y 0x11 787 #define ABS_HAT1X 0x12 788 #define ABS_HAT1Y 0x13 789 #define ABS_HAT2X 0x14 790 #define ABS_HAT2Y 0x15 791 #define ABS_HAT3X 0x16 792 #define ABS_HAT3Y 0x17 793 #define ABS_PRESSURE 0x18 794 #define ABS_DISTANCE 0x19 795 #define ABS_TILT_X 0x1a 796 #define ABS_TILT_Y 0x1b 797 #define ABS_TOOL_WIDTH 0x1c 798 799 #define ABS_VOLUME 0x20 800 801 #define ABS_MISC 0x28 802 803 #define ABS_MT_SLOT 0x2f /* MT slot being modified */ 804 #define ABS_MT_TOUCH_MAJOR 0x30 /* Major axis of touching ellipse */ 805 #define ABS_MT_TOUCH_MINOR 0x31 /* Minor axis (omit if circular) */ 806 #define ABS_MT_WIDTH_MAJOR 0x32 /* Major axis of approaching ellipse */ 807 #define ABS_MT_WIDTH_MINOR 0x33 /* Minor axis (omit if circular) */ 808 #define ABS_MT_ORIENTATION 0x34 /* Ellipse orientation */ 809 #define ABS_MT_POSITION_X 0x35 /* Center X ellipse position */ 810 #define ABS_MT_POSITION_Y 0x36 /* Center Y ellipse position */ 811 #define ABS_MT_TOOL_TYPE 0x37 /* Type of touching device */ 812 #define ABS_MT_BLOB_ID 0x38 /* Group a set of packets as a blob */ 813 #define ABS_MT_TRACKING_ID 0x39 /* Unique ID of initiated contact */ 814 #define ABS_MT_PRESSURE 0x3a /* Pressure on contact area */ 815 #define ABS_MT_DISTANCE 0x3b /* Contact hover distance */ 816 817 #ifdef __KERNEL__ 818 /* Implementation details, userspace should not care about these */ 819 #define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR 820 #define ABS_MT_LAST ABS_MT_DISTANCE 821 #endif 822 823 #define ABS_MAX 0x3f 824 #define ABS_CNT (ABS_MAX+1) 825 826 /* 827 * Switch events 828 */ 829 830 #define SW_LID 0x00 /* set = lid shut */ 831 #define SW_TABLET_MODE 0x01 /* set = tablet mode */ 832 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */ 833 #define SW_RFKILL_ALL 0x03 /* rfkill master switch, type "any" 834 set = radio enabled */ 835 #define SW_RADIO SW_RFKILL_ALL /* deprecated */ 836 #define SW_MICROPHONE_INSERT 0x04 /* set = inserted */ 837 #define SW_DOCK 0x05 /* set = plugged into dock */ 838 #define SW_LINEOUT_INSERT 0x06 /* set = inserted */ 839 #define SW_JACK_PHYSICAL_INSERT 0x07 /* set = mechanical switch set */ 840 #define SW_VIDEOOUT_INSERT 0x08 /* set = inserted */ 841 #define SW_CAMERA_LENS_COVER 0x09 /* set = lens covered */ 842 #define SW_KEYPAD_SLIDE 0x0a /* set = keypad slide out */ 843 #define SW_FRONT_PROXIMITY 0x0b /* set = front proximity sensor active */ 844 #define SW_ROTATE_LOCK 0x0c /* set = rotate locked/disabled */ 845 #define SW_LINEIN_INSERT 0x0d /* set = inserted */ 846 #define SW_MAX 0x0f 847 #define SW_CNT (SW_MAX+1) 848 849 /* 850 * Misc events 851 */ 852 853 #define MSC_SERIAL 0x00 854 #define MSC_PULSELED 0x01 855 #define MSC_GESTURE 0x02 856 #define MSC_RAW 0x03 857 #define MSC_SCAN 0x04 858 #define MSC_MAX 0x07 859 #define MSC_CNT (MSC_MAX+1) 860 861 /* 862 * LEDs 863 */ 864 865 #define LED_NUML 0x00 866 #define LED_CAPSL 0x01 867 #define LED_SCROLLL 0x02 868 #define LED_COMPOSE 0x03 869 #define LED_KANA 0x04 870 #define LED_SLEEP 0x05 871 #define LED_SUSPEND 0x06 872 #define LED_MUTE 0x07 873 #define LED_MISC 0x08 874 #define LED_MAIL 0x09 875 #define LED_CHARGING 0x0a 876 #define LED_MAX 0x0f 877 #define LED_CNT (LED_MAX+1) 878 879 /* 880 * Autorepeat values 881 */ 882 883 #define REP_DELAY 0x00 884 #define REP_PERIOD 0x01 885 #define REP_MAX 0x01 886 #define REP_CNT (REP_MAX+1) 887 888 /* 889 * Sounds 890 */ 891 892 #define SND_CLICK 0x00 893 #define SND_BELL 0x01 894 #define SND_TONE 0x02 895 #define SND_MAX 0x07 896 #define SND_CNT (SND_MAX+1) 897 898 /* 899 * IDs. 900 */ 901 902 #define ID_BUS 0 903 #define ID_VENDOR 1 904 #define ID_PRODUCT 2 905 #define ID_VERSION 3 906 907 #define BUS_PCI 0x01 908 #define BUS_ISAPNP 0x02 909 #define BUS_USB 0x03 910 #define BUS_HIL 0x04 911 #define BUS_BLUETOOTH 0x05 912 #define BUS_VIRTUAL 0x06 913 914 #define BUS_ISA 0x10 915 #define BUS_I8042 0x11 916 #define BUS_XTKBD 0x12 917 #define BUS_RS232 0x13 918 #define BUS_GAMEPORT 0x14 919 #define BUS_PARPORT 0x15 920 #define BUS_AMIGA 0x16 921 #define BUS_ADB 0x17 922 #define BUS_I2C 0x18 923 #define BUS_HOST 0x19 924 #define BUS_GSC 0x1A 925 #define BUS_ATARI 0x1B 926 #define BUS_SPI 0x1C 927 928 /* 929 * MT_TOOL types 930 */ 931 #define MT_TOOL_FINGER 0 932 #define MT_TOOL_PEN 1 933 #define MT_TOOL_MAX 1 934 935 /* 936 * Values describing the status of a force-feedback effect 937 */ 938 #define FF_STATUS_STOPPED 0x00 939 #define FF_STATUS_PLAYING 0x01 940 #define FF_STATUS_MAX 0x01 941 942 /* 943 * Structures used in ioctls to upload effects to a device 944 * They are pieces of a bigger structure (called ff_effect) 945 */ 946 947 /* 948 * All duration values are expressed in ms. Values above 32767 ms (0x7fff) 949 * should not be used and have unspecified results. 950 */ 951 952 /** 953 * struct ff_replay - defines scheduling of the force-feedback effect 954 * @length: duration of the effect 955 * @delay: delay before effect should start playing 956 */ 957 struct ff_replay { 958 __u16 length; 959 __u16 delay; 960 }; 961 962 /** 963 * struct ff_trigger - defines what triggers the force-feedback effect 964 * @button: number of the button triggering the effect 965 * @interval: controls how soon the effect can be re-triggered 966 */ 967 struct ff_trigger { 968 __u16 button; 969 __u16 interval; 970 }; 971 972 /** 973 * struct ff_envelope - generic force-feedback effect envelope 974 * @attack_length: duration of the attack (ms) 975 * @attack_level: level at the beginning of the attack 976 * @fade_length: duration of fade (ms) 977 * @fade_level: level at the end of fade 978 * 979 * The @attack_level and @fade_level are absolute values; when applying 980 * envelope force-feedback core will convert to positive/negative 981 * value based on polarity of the default level of the effect. 982 * Valid range for the attack and fade levels is 0x0000 - 0x7fff 983 */ 984 struct ff_envelope { 985 __u16 attack_length; 986 __u16 attack_level; 987 __u16 fade_length; 988 __u16 fade_level; 989 }; 990 991 /** 992 * struct ff_constant_effect - defines parameters of a constant force-feedback effect 993 * @level: strength of the effect; may be negative 994 * @envelope: envelope data 995 */ 996 struct ff_constant_effect { 997 __s16 level; 998 struct ff_envelope envelope; 999 }; 1000 1001 /** 1002 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect 1003 * @start_level: beginning strength of the effect; may be negative 1004 * @end_level: final strength of the effect; may be negative 1005 * @envelope: envelope data 1006 */ 1007 struct ff_ramp_effect { 1008 __s16 start_level; 1009 __s16 end_level; 1010 struct ff_envelope envelope; 1011 }; 1012 1013 /** 1014 * struct ff_condition_effect - defines a spring or friction force-feedback effect 1015 * @right_saturation: maximum level when joystick moved all way to the right 1016 * @left_saturation: same for the left side 1017 * @right_coeff: controls how fast the force grows when the joystick moves 1018 * to the right 1019 * @left_coeff: same for the left side 1020 * @deadband: size of the dead zone, where no force is produced 1021 * @center: position of the dead zone 1022 */ 1023 struct ff_condition_effect { 1024 __u16 right_saturation; 1025 __u16 left_saturation; 1026 1027 __s16 right_coeff; 1028 __s16 left_coeff; 1029 1030 __u16 deadband; 1031 __s16 center; 1032 }; 1033 1034 /** 1035 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect 1036 * @waveform: kind of the effect (wave) 1037 * @period: period of the wave (ms) 1038 * @magnitude: peak value 1039 * @offset: mean value of the wave (roughly) 1040 * @phase: 'horizontal' shift 1041 * @envelope: envelope data 1042 * @custom_len: number of samples (FF_CUSTOM only) 1043 * @custom_data: buffer of samples (FF_CUSTOM only) 1044 * 1045 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, 1046 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined 1047 * for the time being as no driver supports it yet. 1048 * 1049 * Note: the data pointed by custom_data is copied by the driver. 1050 * You can therefore dispose of the memory after the upload/update. 1051 */ 1052 struct ff_periodic_effect { 1053 __u16 waveform; 1054 __u16 period; 1055 __s16 magnitude; 1056 __s16 offset; 1057 __u16 phase; 1058 1059 struct ff_envelope envelope; 1060 1061 __u32 custom_len; 1062 __s16 __user *custom_data; 1063 }; 1064 1065 /** 1066 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect 1067 * @strong_magnitude: magnitude of the heavy motor 1068 * @weak_magnitude: magnitude of the light one 1069 * 1070 * Some rumble pads have two motors of different weight. Strong_magnitude 1071 * represents the magnitude of the vibration generated by the heavy one. 1072 */ 1073 struct ff_rumble_effect { 1074 __u16 strong_magnitude; 1075 __u16 weak_magnitude; 1076 }; 1077 1078 /** 1079 * struct ff_effect - defines force feedback effect 1080 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING, 1081 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM) 1082 * @id: an unique id assigned to an effect 1083 * @direction: direction of the effect 1084 * @trigger: trigger conditions (struct ff_trigger) 1085 * @replay: scheduling of the effect (struct ff_replay) 1086 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect, 1087 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further 1088 * defining effect parameters 1089 * 1090 * This structure is sent through ioctl from the application to the driver. 1091 * To create a new effect application should set its @id to -1; the kernel 1092 * will return assigned @id which can later be used to update or delete 1093 * this effect. 1094 * 1095 * Direction of the effect is encoded as follows: 1096 * 0 deg -> 0x0000 (down) 1097 * 90 deg -> 0x4000 (left) 1098 * 180 deg -> 0x8000 (up) 1099 * 270 deg -> 0xC000 (right) 1100 */ 1101 struct ff_effect { 1102 __u16 type; 1103 __s16 id; 1104 __u16 direction; 1105 struct ff_trigger trigger; 1106 struct ff_replay replay; 1107 1108 union { 1109 struct ff_constant_effect constant; 1110 struct ff_ramp_effect ramp; 1111 struct ff_periodic_effect periodic; 1112 struct ff_condition_effect condition[2]; /* One for each axis */ 1113 struct ff_rumble_effect rumble; 1114 } u; 1115 }; 1116 1117 /* 1118 * Force feedback effect types 1119 */ 1120 1121 #define FF_RUMBLE 0x50 1122 #define FF_PERIODIC 0x51 1123 #define FF_CONSTANT 0x52 1124 #define FF_SPRING 0x53 1125 #define FF_FRICTION 0x54 1126 #define FF_DAMPER 0x55 1127 #define FF_INERTIA 0x56 1128 #define FF_RAMP 0x57 1129 1130 #define FF_EFFECT_MIN FF_RUMBLE 1131 #define FF_EFFECT_MAX FF_RAMP 1132 1133 /* 1134 * Force feedback periodic effect types 1135 */ 1136 1137 #define FF_SQUARE 0x58 1138 #define FF_TRIANGLE 0x59 1139 #define FF_SINE 0x5a 1140 #define FF_SAW_UP 0x5b 1141 #define FF_SAW_DOWN 0x5c 1142 #define FF_CUSTOM 0x5d 1143 1144 #define FF_WAVEFORM_MIN FF_SQUARE 1145 #define FF_WAVEFORM_MAX FF_CUSTOM 1146 1147 /* 1148 * Set ff device properties 1149 */ 1150 1151 #define FF_GAIN 0x60 1152 #define FF_AUTOCENTER 0x61 1153 1154 #define FF_MAX 0x7f 1155 #define FF_CNT (FF_MAX+1) 1156 1157 #ifdef __KERNEL__ 1158 1159 /* 1160 * In-kernel definitions. 1161 */ 1162 1163 #include <linux/device.h> 1164 #include <linux/fs.h> 1165 #include <linux/timer.h> 1166 #include <linux/mod_devicetable.h> 1167 1168 /** 1169 * struct input_dev - represents an input device 1170 * @name: name of the device 1171 * @phys: physical path to the device in the system hierarchy 1172 * @uniq: unique identification code for the device (if device has it) 1173 * @id: id of the device (struct input_id) 1174 * @propbit: bitmap of device properties and quirks 1175 * @evbit: bitmap of types of events supported by the device (EV_KEY, 1176 * EV_REL, etc.) 1177 * @keybit: bitmap of keys/buttons this device has 1178 * @relbit: bitmap of relative axes for the device 1179 * @absbit: bitmap of absolute axes for the device 1180 * @mscbit: bitmap of miscellaneous events supported by the device 1181 * @ledbit: bitmap of leds present on the device 1182 * @sndbit: bitmap of sound effects supported by the device 1183 * @ffbit: bitmap of force feedback effects supported by the device 1184 * @swbit: bitmap of switches present on the device 1185 * @hint_events_per_packet: average number of events generated by the 1186 * device in a packet (between EV_SYN/SYN_REPORT events). Used by 1187 * event handlers to estimate size of the buffer needed to hold 1188 * events. 1189 * @keycodemax: size of keycode table 1190 * @keycodesize: size of elements in keycode table 1191 * @keycode: map of scancodes to keycodes for this device 1192 * @getkeycode: optional legacy method to retrieve current keymap. 1193 * @setkeycode: optional method to alter current keymap, used to implement 1194 * sparse keymaps. If not supplied default mechanism will be used. 1195 * The method is being called while holding event_lock and thus must 1196 * not sleep 1197 * @ff: force feedback structure associated with the device if device 1198 * supports force feedback effects 1199 * @repeat_key: stores key code of the last key pressed; used to implement 1200 * software autorepeat 1201 * @timer: timer for software autorepeat 1202 * @rep: current values for autorepeat parameters (delay, rate) 1203 * @mt: pointer to array of struct input_mt_slot holding current values 1204 * of tracked contacts 1205 * @mtsize: number of MT slots the device uses 1206 * @slot: MT slot currently being transmitted 1207 * @trkid: stores MT tracking ID for the current contact 1208 * @absinfo: array of &struct input_absinfo elements holding information 1209 * about absolute axes (current value, min, max, flat, fuzz, 1210 * resolution) 1211 * @key: reflects current state of device's keys/buttons 1212 * @led: reflects current state of device's LEDs 1213 * @snd: reflects current state of sound effects 1214 * @sw: reflects current state of device's switches 1215 * @open: this method is called when the very first user calls 1216 * input_open_device(). The driver must prepare the device 1217 * to start generating events (start polling thread, 1218 * request an IRQ, submit URB, etc.) 1219 * @close: this method is called when the very last user calls 1220 * input_close_device(). 1221 * @flush: purges the device. Most commonly used to get rid of force 1222 * feedback effects loaded into the device when disconnecting 1223 * from it 1224 * @event: event handler for events sent _to_ the device, like EV_LED 1225 * or EV_SND. The device is expected to carry out the requested 1226 * action (turn on a LED, play sound, etc.) The call is protected 1227 * by @event_lock and must not sleep 1228 * @grab: input handle that currently has the device grabbed (via 1229 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole 1230 * recipient for all input events coming from the device 1231 * @event_lock: this spinlock is is taken when input core receives 1232 * and processes a new event for the device (in input_event()). 1233 * Code that accesses and/or modifies parameters of a device 1234 * (such as keymap or absmin, absmax, absfuzz, etc.) after device 1235 * has been registered with input core must take this lock. 1236 * @mutex: serializes calls to open(), close() and flush() methods 1237 * @users: stores number of users (input handlers) that opened this 1238 * device. It is used by input_open_device() and input_close_device() 1239 * to make sure that dev->open() is only called when the first 1240 * user opens device and dev->close() is called when the very 1241 * last user closes the device 1242 * @going_away: marks devices that are in a middle of unregistering and 1243 * causes input_open_device*() fail with -ENODEV. 1244 * @sync: set to %true when there were no new events since last EV_SYN 1245 * @dev: driver model's view of this device 1246 * @h_list: list of input handles associated with the device. When 1247 * accessing the list dev->mutex must be held 1248 * @node: used to place the device onto input_dev_list 1249 */ 1250 struct input_dev { 1251 const char *name; 1252 const char *phys; 1253 const char *uniq; 1254 struct input_id id; 1255 1256 unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)]; 1257 1258 unsigned long evbit[BITS_TO_LONGS(EV_CNT)]; 1259 unsigned long keybit[BITS_TO_LONGS(KEY_CNT)]; 1260 unsigned long relbit[BITS_TO_LONGS(REL_CNT)]; 1261 unsigned long absbit[BITS_TO_LONGS(ABS_CNT)]; 1262 unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)]; 1263 unsigned long ledbit[BITS_TO_LONGS(LED_CNT)]; 1264 unsigned long sndbit[BITS_TO_LONGS(SND_CNT)]; 1265 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)]; 1266 unsigned long swbit[BITS_TO_LONGS(SW_CNT)]; 1267 1268 unsigned int hint_events_per_packet; 1269 1270 unsigned int keycodemax; 1271 unsigned int keycodesize; 1272 void *keycode; 1273 1274 int (*setkeycode)(struct input_dev *dev, 1275 const struct input_keymap_entry *ke, 1276 unsigned int *old_keycode); 1277 int (*getkeycode)(struct input_dev *dev, 1278 struct input_keymap_entry *ke); 1279 1280 struct ff_device *ff; 1281 1282 unsigned int repeat_key; 1283 struct timer_list timer; 1284 1285 int rep[REP_CNT]; 1286 1287 struct input_mt_slot *mt; 1288 int mtsize; 1289 int slot; 1290 int trkid; 1291 1292 struct input_absinfo *absinfo; 1293 1294 unsigned long key[BITS_TO_LONGS(KEY_CNT)]; 1295 unsigned long led[BITS_TO_LONGS(LED_CNT)]; 1296 unsigned long snd[BITS_TO_LONGS(SND_CNT)]; 1297 unsigned long sw[BITS_TO_LONGS(SW_CNT)]; 1298 1299 int (*open)(struct input_dev *dev); 1300 void (*close)(struct input_dev *dev); 1301 int (*flush)(struct input_dev *dev, struct file *file); 1302 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value); 1303 1304 struct input_handle __rcu *grab; 1305 1306 spinlock_t event_lock; 1307 struct mutex mutex; 1308 1309 unsigned int users; 1310 bool going_away; 1311 1312 bool sync; 1313 1314 struct device dev; 1315 1316 struct list_head h_list; 1317 struct list_head node; 1318 }; 1319 #define to_input_dev(d) container_of(d, struct input_dev, dev) 1320 1321 /* 1322 * Verify that we are in sync with input_device_id mod_devicetable.h #defines 1323 */ 1324 1325 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX 1326 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match" 1327 #endif 1328 1329 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING 1330 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match" 1331 #endif 1332 1333 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX 1334 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match" 1335 #endif 1336 1337 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX 1338 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match" 1339 #endif 1340 1341 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX 1342 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match" 1343 #endif 1344 1345 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX 1346 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match" 1347 #endif 1348 1349 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX 1350 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match" 1351 #endif 1352 1353 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX 1354 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match" 1355 #endif 1356 1357 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX 1358 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match" 1359 #endif 1360 1361 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX 1362 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match" 1363 #endif 1364 1365 #define INPUT_DEVICE_ID_MATCH_DEVICE \ 1366 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT) 1367 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \ 1368 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION) 1369 1370 struct input_handle; 1371 1372 /** 1373 * struct input_handler - implements one of interfaces for input devices 1374 * @private: driver-specific data 1375 * @event: event handler. This method is being called by input core with 1376 * interrupts disabled and dev->event_lock spinlock held and so 1377 * it may not sleep 1378 * @filter: similar to @event; separates normal event handlers from 1379 * "filters". 1380 * @match: called after comparing device's id with handler's id_table 1381 * to perform fine-grained matching between device and handler 1382 * @connect: called when attaching a handler to an input device 1383 * @disconnect: disconnects a handler from input device 1384 * @start: starts handler for given handle. This function is called by 1385 * input core right after connect() method and also when a process 1386 * that "grabbed" a device releases it 1387 * @fops: file operations this driver implements 1388 * @minor: beginning of range of 32 minors for devices this driver 1389 * can provide 1390 * @name: name of the handler, to be shown in /proc/bus/input/handlers 1391 * @id_table: pointer to a table of input_device_ids this driver can 1392 * handle 1393 * @h_list: list of input handles associated with the handler 1394 * @node: for placing the driver onto input_handler_list 1395 * 1396 * Input handlers attach to input devices and create input handles. There 1397 * are likely several handlers attached to any given input device at the 1398 * same time. All of them will get their copy of input event generated by 1399 * the device. 1400 * 1401 * The very same structure is used to implement input filters. Input core 1402 * allows filters to run first and will not pass event to regular handlers 1403 * if any of the filters indicate that the event should be filtered (by 1404 * returning %true from their filter() method). 1405 * 1406 * Note that input core serializes calls to connect() and disconnect() 1407 * methods. 1408 */ 1409 struct input_handler { 1410 1411 void *private; 1412 1413 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value); 1414 bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value); 1415 bool (*match)(struct input_handler *handler, struct input_dev *dev); 1416 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id); 1417 void (*disconnect)(struct input_handle *handle); 1418 void (*start)(struct input_handle *handle); 1419 1420 const struct file_operations *fops; 1421 int minor; 1422 const char *name; 1423 1424 const struct input_device_id *id_table; 1425 1426 struct list_head h_list; 1427 struct list_head node; 1428 }; 1429 1430 /** 1431 * struct input_handle - links input device with an input handler 1432 * @private: handler-specific data 1433 * @open: counter showing whether the handle is 'open', i.e. should deliver 1434 * events from its device 1435 * @name: name given to the handle by handler that created it 1436 * @dev: input device the handle is attached to 1437 * @handler: handler that works with the device through this handle 1438 * @d_node: used to put the handle on device's list of attached handles 1439 * @h_node: used to put the handle on handler's list of handles from which 1440 * it gets events 1441 */ 1442 struct input_handle { 1443 1444 void *private; 1445 1446 int open; 1447 const char *name; 1448 1449 struct input_dev *dev; 1450 struct input_handler *handler; 1451 1452 struct list_head d_node; 1453 struct list_head h_node; 1454 }; 1455 1456 struct input_dev *input_allocate_device(void); 1457 void input_free_device(struct input_dev *dev); 1458 1459 static inline struct input_dev *input_get_device(struct input_dev *dev) 1460 { 1461 return dev ? to_input_dev(get_device(&dev->dev)) : NULL; 1462 } 1463 1464 static inline void input_put_device(struct input_dev *dev) 1465 { 1466 if (dev) 1467 put_device(&dev->dev); 1468 } 1469 1470 static inline void *input_get_drvdata(struct input_dev *dev) 1471 { 1472 return dev_get_drvdata(&dev->dev); 1473 } 1474 1475 static inline void input_set_drvdata(struct input_dev *dev, void *data) 1476 { 1477 dev_set_drvdata(&dev->dev, data); 1478 } 1479 1480 int __must_check input_register_device(struct input_dev *); 1481 void input_unregister_device(struct input_dev *); 1482 1483 void input_reset_device(struct input_dev *); 1484 1485 int __must_check input_register_handler(struct input_handler *); 1486 void input_unregister_handler(struct input_handler *); 1487 1488 int input_handler_for_each_handle(struct input_handler *, void *data, 1489 int (*fn)(struct input_handle *, void *)); 1490 1491 int input_register_handle(struct input_handle *); 1492 void input_unregister_handle(struct input_handle *); 1493 1494 int input_grab_device(struct input_handle *); 1495 void input_release_device(struct input_handle *); 1496 1497 int input_open_device(struct input_handle *); 1498 void input_close_device(struct input_handle *); 1499 1500 int input_flush_device(struct input_handle *handle, struct file *file); 1501 1502 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value); 1503 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value); 1504 1505 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value) 1506 { 1507 input_event(dev, EV_KEY, code, !!value); 1508 } 1509 1510 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value) 1511 { 1512 input_event(dev, EV_REL, code, value); 1513 } 1514 1515 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value) 1516 { 1517 input_event(dev, EV_ABS, code, value); 1518 } 1519 1520 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value) 1521 { 1522 input_event(dev, EV_FF_STATUS, code, value); 1523 } 1524 1525 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value) 1526 { 1527 input_event(dev, EV_SW, code, !!value); 1528 } 1529 1530 static inline void input_sync(struct input_dev *dev) 1531 { 1532 input_event(dev, EV_SYN, SYN_REPORT, 0); 1533 } 1534 1535 static inline void input_mt_sync(struct input_dev *dev) 1536 { 1537 input_event(dev, EV_SYN, SYN_MT_REPORT, 0); 1538 } 1539 1540 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code); 1541 1542 /** 1543 * input_set_events_per_packet - tell handlers about the driver event rate 1544 * @dev: the input device used by the driver 1545 * @n_events: the average number of events between calls to input_sync() 1546 * 1547 * If the event rate sent from a device is unusually large, use this 1548 * function to set the expected event rate. This will allow handlers 1549 * to set up an appropriate buffer size for the event stream, in order 1550 * to minimize information loss. 1551 */ 1552 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events) 1553 { 1554 dev->hint_events_per_packet = n_events; 1555 } 1556 1557 void input_alloc_absinfo(struct input_dev *dev); 1558 void input_set_abs_params(struct input_dev *dev, unsigned int axis, 1559 int min, int max, int fuzz, int flat); 1560 1561 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item) \ 1562 static inline int input_abs_get_##_suffix(struct input_dev *dev, \ 1563 unsigned int axis) \ 1564 { \ 1565 return dev->absinfo ? dev->absinfo[axis]._item : 0; \ 1566 } \ 1567 \ 1568 static inline void input_abs_set_##_suffix(struct input_dev *dev, \ 1569 unsigned int axis, int val) \ 1570 { \ 1571 input_alloc_absinfo(dev); \ 1572 if (dev->absinfo) \ 1573 dev->absinfo[axis]._item = val; \ 1574 } 1575 1576 INPUT_GENERATE_ABS_ACCESSORS(val, value) 1577 INPUT_GENERATE_ABS_ACCESSORS(min, minimum) 1578 INPUT_GENERATE_ABS_ACCESSORS(max, maximum) 1579 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz) 1580 INPUT_GENERATE_ABS_ACCESSORS(flat, flat) 1581 INPUT_GENERATE_ABS_ACCESSORS(res, resolution) 1582 1583 int input_scancode_to_scalar(const struct input_keymap_entry *ke, 1584 unsigned int *scancode); 1585 1586 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke); 1587 int input_set_keycode(struct input_dev *dev, 1588 const struct input_keymap_entry *ke); 1589 1590 extern struct class input_class; 1591 1592 /** 1593 * struct ff_device - force-feedback part of an input device 1594 * @upload: Called to upload an new effect into device 1595 * @erase: Called to erase an effect from device 1596 * @playback: Called to request device to start playing specified effect 1597 * @set_gain: Called to set specified gain 1598 * @set_autocenter: Called to auto-center device 1599 * @destroy: called by input core when parent input device is being 1600 * destroyed 1601 * @private: driver-specific data, will be freed automatically 1602 * @ffbit: bitmap of force feedback capabilities truly supported by 1603 * device (not emulated like ones in input_dev->ffbit) 1604 * @mutex: mutex for serializing access to the device 1605 * @max_effects: maximum number of effects supported by device 1606 * @effects: pointer to an array of effects currently loaded into device 1607 * @effect_owners: array of effect owners; when file handle owning 1608 * an effect gets closed the effect is automatically erased 1609 * 1610 * Every force-feedback device must implement upload() and playback() 1611 * methods; erase() is optional. set_gain() and set_autocenter() need 1612 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER 1613 * bits. 1614 * 1615 * Note that playback(), set_gain() and set_autocenter() are called with 1616 * dev->event_lock spinlock held and interrupts off and thus may not 1617 * sleep. 1618 */ 1619 struct ff_device { 1620 int (*upload)(struct input_dev *dev, struct ff_effect *effect, 1621 struct ff_effect *old); 1622 int (*erase)(struct input_dev *dev, int effect_id); 1623 1624 int (*playback)(struct input_dev *dev, int effect_id, int value); 1625 void (*set_gain)(struct input_dev *dev, u16 gain); 1626 void (*set_autocenter)(struct input_dev *dev, u16 magnitude); 1627 1628 void (*destroy)(struct ff_device *); 1629 1630 void *private; 1631 1632 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)]; 1633 1634 struct mutex mutex; 1635 1636 int max_effects; 1637 struct ff_effect *effects; 1638 struct file *effect_owners[]; 1639 }; 1640 1641 int input_ff_create(struct input_dev *dev, unsigned int max_effects); 1642 void input_ff_destroy(struct input_dev *dev); 1643 1644 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value); 1645 1646 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file); 1647 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file); 1648 1649 int input_ff_create_memless(struct input_dev *dev, void *data, 1650 int (*play_effect)(struct input_dev *, void *, struct ff_effect *)); 1651 1652 #endif 1653 #endif 1654