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