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