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 <asm/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 0x010000 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 struct input_absinfo { 51 __s32 value; 52 __s32 minimum; 53 __s32 maximum; 54 __s32 fuzz; 55 __s32 flat; 56 }; 57 58 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */ 59 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */ 60 #define EVIOCGREP _IOR('E', 0x03, int[2]) /* get repeat settings */ 61 #define EVIOCSREP _IOW('E', 0x03, int[2]) /* set repeat settings */ 62 #define EVIOCGKEYCODE _IOR('E', 0x04, int[2]) /* get keycode */ 63 #define EVIOCSKEYCODE _IOW('E', 0x04, int[2]) /* set keycode */ 64 65 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */ 66 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */ 67 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */ 68 69 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global keystate */ 70 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */ 71 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */ 72 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */ 73 74 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + ev, len) /* get event bits */ 75 #define EVIOCGABS(abs) _IOR('E', 0x40 + abs, struct input_absinfo) /* get abs value/limits */ 76 #define EVIOCSABS(abs) _IOW('E', 0xc0 + abs, struct input_absinfo) /* set abs value/limits */ 77 78 #define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */ 79 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */ 80 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */ 81 82 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */ 83 84 /* 85 * Event types 86 */ 87 88 #define EV_SYN 0x00 89 #define EV_KEY 0x01 90 #define EV_REL 0x02 91 #define EV_ABS 0x03 92 #define EV_MSC 0x04 93 #define EV_SW 0x05 94 #define EV_LED 0x11 95 #define EV_SND 0x12 96 #define EV_REP 0x14 97 #define EV_FF 0x15 98 #define EV_PWR 0x16 99 #define EV_FF_STATUS 0x17 100 #define EV_MAX 0x1f 101 102 /* 103 * Synchronization events. 104 */ 105 106 #define SYN_REPORT 0 107 #define SYN_CONFIG 1 108 109 /* 110 * Keys and buttons 111 * 112 * Most of the keys/buttons are modeled after USB HUT 1.12 113 * (see http://www.usb.org/developers/hidpage). 114 * Abbreviations in the comments: 115 * AC - Application Control 116 * AL - Application Launch Button 117 * SC - System Control 118 */ 119 120 #define KEY_RESERVED 0 121 #define KEY_ESC 1 122 #define KEY_1 2 123 #define KEY_2 3 124 #define KEY_3 4 125 #define KEY_4 5 126 #define KEY_5 6 127 #define KEY_6 7 128 #define KEY_7 8 129 #define KEY_8 9 130 #define KEY_9 10 131 #define KEY_0 11 132 #define KEY_MINUS 12 133 #define KEY_EQUAL 13 134 #define KEY_BACKSPACE 14 135 #define KEY_TAB 15 136 #define KEY_Q 16 137 #define KEY_W 17 138 #define KEY_E 18 139 #define KEY_R 19 140 #define KEY_T 20 141 #define KEY_Y 21 142 #define KEY_U 22 143 #define KEY_I 23 144 #define KEY_O 24 145 #define KEY_P 25 146 #define KEY_LEFTBRACE 26 147 #define KEY_RIGHTBRACE 27 148 #define KEY_ENTER 28 149 #define KEY_LEFTCTRL 29 150 #define KEY_A 30 151 #define KEY_S 31 152 #define KEY_D 32 153 #define KEY_F 33 154 #define KEY_G 34 155 #define KEY_H 35 156 #define KEY_J 36 157 #define KEY_K 37 158 #define KEY_L 38 159 #define KEY_SEMICOLON 39 160 #define KEY_APOSTROPHE 40 161 #define KEY_GRAVE 41 162 #define KEY_LEFTSHIFT 42 163 #define KEY_BACKSLASH 43 164 #define KEY_Z 44 165 #define KEY_X 45 166 #define KEY_C 46 167 #define KEY_V 47 168 #define KEY_B 48 169 #define KEY_N 49 170 #define KEY_M 50 171 #define KEY_COMMA 51 172 #define KEY_DOT 52 173 #define KEY_SLASH 53 174 #define KEY_RIGHTSHIFT 54 175 #define KEY_KPASTERISK 55 176 #define KEY_LEFTALT 56 177 #define KEY_SPACE 57 178 #define KEY_CAPSLOCK 58 179 #define KEY_F1 59 180 #define KEY_F2 60 181 #define KEY_F3 61 182 #define KEY_F4 62 183 #define KEY_F5 63 184 #define KEY_F6 64 185 #define KEY_F7 65 186 #define KEY_F8 66 187 #define KEY_F9 67 188 #define KEY_F10 68 189 #define KEY_NUMLOCK 69 190 #define KEY_SCROLLLOCK 70 191 #define KEY_KP7 71 192 #define KEY_KP8 72 193 #define KEY_KP9 73 194 #define KEY_KPMINUS 74 195 #define KEY_KP4 75 196 #define KEY_KP5 76 197 #define KEY_KP6 77 198 #define KEY_KPPLUS 78 199 #define KEY_KP1 79 200 #define KEY_KP2 80 201 #define KEY_KP3 81 202 #define KEY_KP0 82 203 #define KEY_KPDOT 83 204 205 #define KEY_ZENKAKUHANKAKU 85 206 #define KEY_102ND 86 207 #define KEY_F11 87 208 #define KEY_F12 88 209 #define KEY_RO 89 210 #define KEY_KATAKANA 90 211 #define KEY_HIRAGANA 91 212 #define KEY_HENKAN 92 213 #define KEY_KATAKANAHIRAGANA 93 214 #define KEY_MUHENKAN 94 215 #define KEY_KPJPCOMMA 95 216 #define KEY_KPENTER 96 217 #define KEY_RIGHTCTRL 97 218 #define KEY_KPSLASH 98 219 #define KEY_SYSRQ 99 220 #define KEY_RIGHTALT 100 221 #define KEY_LINEFEED 101 222 #define KEY_HOME 102 223 #define KEY_UP 103 224 #define KEY_PAGEUP 104 225 #define KEY_LEFT 105 226 #define KEY_RIGHT 106 227 #define KEY_END 107 228 #define KEY_DOWN 108 229 #define KEY_PAGEDOWN 109 230 #define KEY_INSERT 110 231 #define KEY_DELETE 111 232 #define KEY_MACRO 112 233 #define KEY_MUTE 113 234 #define KEY_VOLUMEDOWN 114 235 #define KEY_VOLUMEUP 115 236 #define KEY_POWER 116 /* SC System Power Down */ 237 #define KEY_KPEQUAL 117 238 #define KEY_KPPLUSMINUS 118 239 #define KEY_PAUSE 119 240 241 #define KEY_KPCOMMA 121 242 #define KEY_HANGEUL 122 243 #define KEY_HANGUEL KEY_HANGEUL 244 #define KEY_HANJA 123 245 #define KEY_YEN 124 246 #define KEY_LEFTMETA 125 247 #define KEY_RIGHTMETA 126 248 #define KEY_COMPOSE 127 249 250 #define KEY_STOP 128 /* AC Stop */ 251 #define KEY_AGAIN 129 252 #define KEY_PROPS 130 /* AC Properties */ 253 #define KEY_UNDO 131 /* AC Undo */ 254 #define KEY_FRONT 132 255 #define KEY_COPY 133 /* AC Copy */ 256 #define KEY_OPEN 134 /* AC Open */ 257 #define KEY_PASTE 135 /* AC Paste */ 258 #define KEY_FIND 136 /* AC Search */ 259 #define KEY_CUT 137 /* AC Cut */ 260 #define KEY_HELP 138 /* AL Integrated Help Center */ 261 #define KEY_MENU 139 /* Menu (show menu) */ 262 #define KEY_CALC 140 /* AL Calculator */ 263 #define KEY_SETUP 141 264 #define KEY_SLEEP 142 /* SC System Sleep */ 265 #define KEY_WAKEUP 143 /* System Wake Up */ 266 #define KEY_FILE 144 /* AL Local Machine Browser */ 267 #define KEY_SENDFILE 145 268 #define KEY_DELETEFILE 146 269 #define KEY_XFER 147 270 #define KEY_PROG1 148 271 #define KEY_PROG2 149 272 #define KEY_WWW 150 /* AL Internet Browser */ 273 #define KEY_MSDOS 151 274 #define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */ 275 #define KEY_SCREENLOCK KEY_COFFEE 276 #define KEY_DIRECTION 153 277 #define KEY_CYCLEWINDOWS 154 278 #define KEY_MAIL 155 279 #define KEY_BOOKMARKS 156 /* AC Bookmarks */ 280 #define KEY_COMPUTER 157 281 #define KEY_BACK 158 /* AC Back */ 282 #define KEY_FORWARD 159 /* AC Forward */ 283 #define KEY_CLOSECD 160 284 #define KEY_EJECTCD 161 285 #define KEY_EJECTCLOSECD 162 286 #define KEY_NEXTSONG 163 287 #define KEY_PLAYPAUSE 164 288 #define KEY_PREVIOUSSONG 165 289 #define KEY_STOPCD 166 290 #define KEY_RECORD 167 291 #define KEY_REWIND 168 292 #define KEY_PHONE 169 /* Media Select Telephone */ 293 #define KEY_ISO 170 294 #define KEY_CONFIG 171 /* AL Consumer Control Configuration */ 295 #define KEY_HOMEPAGE 172 /* AC Home */ 296 #define KEY_REFRESH 173 /* AC Refresh */ 297 #define KEY_EXIT 174 /* AC Exit */ 298 #define KEY_MOVE 175 299 #define KEY_EDIT 176 300 #define KEY_SCROLLUP 177 301 #define KEY_SCROLLDOWN 178 302 #define KEY_KPLEFTPAREN 179 303 #define KEY_KPRIGHTPAREN 180 304 #define KEY_NEW 181 /* AC New */ 305 #define KEY_REDO 182 /* AC Redo/Repeat */ 306 307 #define KEY_F13 183 308 #define KEY_F14 184 309 #define KEY_F15 185 310 #define KEY_F16 186 311 #define KEY_F17 187 312 #define KEY_F18 188 313 #define KEY_F19 189 314 #define KEY_F20 190 315 #define KEY_F21 191 316 #define KEY_F22 192 317 #define KEY_F23 193 318 #define KEY_F24 194 319 320 #define KEY_PLAYCD 200 321 #define KEY_PAUSECD 201 322 #define KEY_PROG3 202 323 #define KEY_PROG4 203 324 #define KEY_SUSPEND 205 325 #define KEY_CLOSE 206 /* AC Close */ 326 #define KEY_PLAY 207 327 #define KEY_FASTFORWARD 208 328 #define KEY_BASSBOOST 209 329 #define KEY_PRINT 210 /* AC Print */ 330 #define KEY_HP 211 331 #define KEY_CAMERA 212 332 #define KEY_SOUND 213 333 #define KEY_QUESTION 214 334 #define KEY_EMAIL 215 335 #define KEY_CHAT 216 336 #define KEY_SEARCH 217 337 #define KEY_CONNECT 218 338 #define KEY_FINANCE 219 /* AL Checkbook/Finance */ 339 #define KEY_SPORT 220 340 #define KEY_SHOP 221 341 #define KEY_ALTERASE 222 342 #define KEY_CANCEL 223 /* AC Cancel */ 343 #define KEY_BRIGHTNESSDOWN 224 344 #define KEY_BRIGHTNESSUP 225 345 #define KEY_MEDIA 226 346 347 #define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video 348 outputs (Monitor/LCD/TV-out/etc) */ 349 #define KEY_KBDILLUMTOGGLE 228 350 #define KEY_KBDILLUMDOWN 229 351 #define KEY_KBDILLUMUP 230 352 353 #define KEY_SEND 231 /* AC Send */ 354 #define KEY_REPLY 232 /* AC Reply */ 355 #define KEY_FORWARDMAIL 233 /* AC Forward Msg */ 356 #define KEY_SAVE 234 /* AC Save */ 357 #define KEY_DOCUMENTS 235 358 359 #define KEY_BATTERY 236 360 361 #define KEY_BLUETOOTH 237 362 #define KEY_WLAN 238 363 #define KEY_UWB 239 364 365 #define KEY_UNKNOWN 240 366 367 #define KEY_VIDEO_NEXT 241 /* drive next video source */ 368 #define KEY_VIDEO_PREV 242 /* drive previous video source */ 369 #define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */ 370 #define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */ 371 #define KEY_DISPLAY_OFF 245 /* display device to off state */ 372 373 #define BTN_MISC 0x100 374 #define BTN_0 0x100 375 #define BTN_1 0x101 376 #define BTN_2 0x102 377 #define BTN_3 0x103 378 #define BTN_4 0x104 379 #define BTN_5 0x105 380 #define BTN_6 0x106 381 #define BTN_7 0x107 382 #define BTN_8 0x108 383 #define BTN_9 0x109 384 385 #define BTN_MOUSE 0x110 386 #define BTN_LEFT 0x110 387 #define BTN_RIGHT 0x111 388 #define BTN_MIDDLE 0x112 389 #define BTN_SIDE 0x113 390 #define BTN_EXTRA 0x114 391 #define BTN_FORWARD 0x115 392 #define BTN_BACK 0x116 393 #define BTN_TASK 0x117 394 395 #define BTN_JOYSTICK 0x120 396 #define BTN_TRIGGER 0x120 397 #define BTN_THUMB 0x121 398 #define BTN_THUMB2 0x122 399 #define BTN_TOP 0x123 400 #define BTN_TOP2 0x124 401 #define BTN_PINKIE 0x125 402 #define BTN_BASE 0x126 403 #define BTN_BASE2 0x127 404 #define BTN_BASE3 0x128 405 #define BTN_BASE4 0x129 406 #define BTN_BASE5 0x12a 407 #define BTN_BASE6 0x12b 408 #define BTN_DEAD 0x12f 409 410 #define BTN_GAMEPAD 0x130 411 #define BTN_A 0x130 412 #define BTN_B 0x131 413 #define BTN_C 0x132 414 #define BTN_X 0x133 415 #define BTN_Y 0x134 416 #define BTN_Z 0x135 417 #define BTN_TL 0x136 418 #define BTN_TR 0x137 419 #define BTN_TL2 0x138 420 #define BTN_TR2 0x139 421 #define BTN_SELECT 0x13a 422 #define BTN_START 0x13b 423 #define BTN_MODE 0x13c 424 #define BTN_THUMBL 0x13d 425 #define BTN_THUMBR 0x13e 426 427 #define BTN_DIGI 0x140 428 #define BTN_TOOL_PEN 0x140 429 #define BTN_TOOL_RUBBER 0x141 430 #define BTN_TOOL_BRUSH 0x142 431 #define BTN_TOOL_PENCIL 0x143 432 #define BTN_TOOL_AIRBRUSH 0x144 433 #define BTN_TOOL_FINGER 0x145 434 #define BTN_TOOL_MOUSE 0x146 435 #define BTN_TOOL_LENS 0x147 436 #define BTN_TOUCH 0x14a 437 #define BTN_STYLUS 0x14b 438 #define BTN_STYLUS2 0x14c 439 #define BTN_TOOL_DOUBLETAP 0x14d 440 #define BTN_TOOL_TRIPLETAP 0x14e 441 442 #define BTN_WHEEL 0x150 443 #define BTN_GEAR_DOWN 0x150 444 #define BTN_GEAR_UP 0x151 445 446 #define KEY_OK 0x160 447 #define KEY_SELECT 0x161 448 #define KEY_GOTO 0x162 449 #define KEY_CLEAR 0x163 450 #define KEY_POWER2 0x164 451 #define KEY_OPTION 0x165 452 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */ 453 #define KEY_TIME 0x167 454 #define KEY_VENDOR 0x168 455 #define KEY_ARCHIVE 0x169 456 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */ 457 #define KEY_CHANNEL 0x16b 458 #define KEY_FAVORITES 0x16c 459 #define KEY_EPG 0x16d 460 #define KEY_PVR 0x16e /* Media Select Home */ 461 #define KEY_MHP 0x16f 462 #define KEY_LANGUAGE 0x170 463 #define KEY_TITLE 0x171 464 #define KEY_SUBTITLE 0x172 465 #define KEY_ANGLE 0x173 466 #define KEY_ZOOM 0x174 467 #define KEY_MODE 0x175 468 #define KEY_KEYBOARD 0x176 469 #define KEY_SCREEN 0x177 470 #define KEY_PC 0x178 /* Media Select Computer */ 471 #define KEY_TV 0x179 /* Media Select TV */ 472 #define KEY_TV2 0x17a /* Media Select Cable */ 473 #define KEY_VCR 0x17b /* Media Select VCR */ 474 #define KEY_VCR2 0x17c /* VCR Plus */ 475 #define KEY_SAT 0x17d /* Media Select Satellite */ 476 #define KEY_SAT2 0x17e 477 #define KEY_CD 0x17f /* Media Select CD */ 478 #define KEY_TAPE 0x180 /* Media Select Tape */ 479 #define KEY_RADIO 0x181 480 #define KEY_TUNER 0x182 /* Media Select Tuner */ 481 #define KEY_PLAYER 0x183 482 #define KEY_TEXT 0x184 483 #define KEY_DVD 0x185 /* Media Select DVD */ 484 #define KEY_AUX 0x186 485 #define KEY_MP3 0x187 486 #define KEY_AUDIO 0x188 487 #define KEY_VIDEO 0x189 488 #define KEY_DIRECTORY 0x18a 489 #define KEY_LIST 0x18b 490 #define KEY_MEMO 0x18c /* Media Select Messages */ 491 #define KEY_CALENDAR 0x18d 492 #define KEY_RED 0x18e 493 #define KEY_GREEN 0x18f 494 #define KEY_YELLOW 0x190 495 #define KEY_BLUE 0x191 496 #define KEY_CHANNELUP 0x192 /* Channel Increment */ 497 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */ 498 #define KEY_FIRST 0x194 499 #define KEY_LAST 0x195 /* Recall Last */ 500 #define KEY_AB 0x196 501 #define KEY_NEXT 0x197 502 #define KEY_RESTART 0x198 503 #define KEY_SLOW 0x199 504 #define KEY_SHUFFLE 0x19a 505 #define KEY_BREAK 0x19b 506 #define KEY_PREVIOUS 0x19c 507 #define KEY_DIGITS 0x19d 508 #define KEY_TEEN 0x19e 509 #define KEY_TWEN 0x19f 510 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */ 511 #define KEY_GAMES 0x1a1 /* Media Select Games */ 512 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */ 513 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */ 514 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */ 515 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */ 516 #define KEY_EDITOR 0x1a6 /* AL Text Editor */ 517 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */ 518 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */ 519 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */ 520 #define KEY_DATABASE 0x1aa /* AL Database App */ 521 #define KEY_NEWS 0x1ab /* AL Newsreader */ 522 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */ 523 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */ 524 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */ 525 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */ 526 527 #define KEY_DEL_EOL 0x1c0 528 #define KEY_DEL_EOS 0x1c1 529 #define KEY_INS_LINE 0x1c2 530 #define KEY_DEL_LINE 0x1c3 531 532 #define KEY_FN 0x1d0 533 #define KEY_FN_ESC 0x1d1 534 #define KEY_FN_F1 0x1d2 535 #define KEY_FN_F2 0x1d3 536 #define KEY_FN_F3 0x1d4 537 #define KEY_FN_F4 0x1d5 538 #define KEY_FN_F5 0x1d6 539 #define KEY_FN_F6 0x1d7 540 #define KEY_FN_F7 0x1d8 541 #define KEY_FN_F8 0x1d9 542 #define KEY_FN_F9 0x1da 543 #define KEY_FN_F10 0x1db 544 #define KEY_FN_F11 0x1dc 545 #define KEY_FN_F12 0x1dd 546 #define KEY_FN_1 0x1de 547 #define KEY_FN_2 0x1df 548 #define KEY_FN_D 0x1e0 549 #define KEY_FN_E 0x1e1 550 #define KEY_FN_F 0x1e2 551 #define KEY_FN_S 0x1e3 552 #define KEY_FN_B 0x1e4 553 554 #define KEY_BRL_DOT1 0x1f1 555 #define KEY_BRL_DOT2 0x1f2 556 #define KEY_BRL_DOT3 0x1f3 557 #define KEY_BRL_DOT4 0x1f4 558 #define KEY_BRL_DOT5 0x1f5 559 #define KEY_BRL_DOT6 0x1f6 560 #define KEY_BRL_DOT7 0x1f7 561 #define KEY_BRL_DOT8 0x1f8 562 #define KEY_BRL_DOT9 0x1f9 563 #define KEY_BRL_DOT10 0x1fa 564 565 /* We avoid low common keys in module aliases so they don't get huge. */ 566 #define KEY_MIN_INTERESTING KEY_MUTE 567 #define KEY_MAX 0x1ff 568 569 /* 570 * Relative axes 571 */ 572 573 #define REL_X 0x00 574 #define REL_Y 0x01 575 #define REL_Z 0x02 576 #define REL_RX 0x03 577 #define REL_RY 0x04 578 #define REL_RZ 0x05 579 #define REL_HWHEEL 0x06 580 #define REL_DIAL 0x07 581 #define REL_WHEEL 0x08 582 #define REL_MISC 0x09 583 #define REL_MAX 0x0f 584 585 /* 586 * Absolute axes 587 */ 588 589 #define ABS_X 0x00 590 #define ABS_Y 0x01 591 #define ABS_Z 0x02 592 #define ABS_RX 0x03 593 #define ABS_RY 0x04 594 #define ABS_RZ 0x05 595 #define ABS_THROTTLE 0x06 596 #define ABS_RUDDER 0x07 597 #define ABS_WHEEL 0x08 598 #define ABS_GAS 0x09 599 #define ABS_BRAKE 0x0a 600 #define ABS_HAT0X 0x10 601 #define ABS_HAT0Y 0x11 602 #define ABS_HAT1X 0x12 603 #define ABS_HAT1Y 0x13 604 #define ABS_HAT2X 0x14 605 #define ABS_HAT2Y 0x15 606 #define ABS_HAT3X 0x16 607 #define ABS_HAT3Y 0x17 608 #define ABS_PRESSURE 0x18 609 #define ABS_DISTANCE 0x19 610 #define ABS_TILT_X 0x1a 611 #define ABS_TILT_Y 0x1b 612 #define ABS_TOOL_WIDTH 0x1c 613 #define ABS_VOLUME 0x20 614 #define ABS_MISC 0x28 615 #define ABS_MAX 0x3f 616 617 /* 618 * Switch events 619 */ 620 621 #define SW_LID 0x00 /* set = lid shut */ 622 #define SW_TABLET_MODE 0x01 /* set = tablet mode */ 623 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */ 624 #define SW_RADIO 0x03 /* set = radio enabled */ 625 #define SW_MAX 0x0f 626 627 /* 628 * Misc events 629 */ 630 631 #define MSC_SERIAL 0x00 632 #define MSC_PULSELED 0x01 633 #define MSC_GESTURE 0x02 634 #define MSC_RAW 0x03 635 #define MSC_SCAN 0x04 636 #define MSC_MAX 0x07 637 638 /* 639 * LEDs 640 */ 641 642 #define LED_NUML 0x00 643 #define LED_CAPSL 0x01 644 #define LED_SCROLLL 0x02 645 #define LED_COMPOSE 0x03 646 #define LED_KANA 0x04 647 #define LED_SLEEP 0x05 648 #define LED_SUSPEND 0x06 649 #define LED_MUTE 0x07 650 #define LED_MISC 0x08 651 #define LED_MAIL 0x09 652 #define LED_CHARGING 0x0a 653 #define LED_MAX 0x0f 654 655 /* 656 * Autorepeat values 657 */ 658 659 #define REP_DELAY 0x00 660 #define REP_PERIOD 0x01 661 #define REP_MAX 0x01 662 663 /* 664 * Sounds 665 */ 666 667 #define SND_CLICK 0x00 668 #define SND_BELL 0x01 669 #define SND_TONE 0x02 670 #define SND_MAX 0x07 671 672 /* 673 * IDs. 674 */ 675 676 #define ID_BUS 0 677 #define ID_VENDOR 1 678 #define ID_PRODUCT 2 679 #define ID_VERSION 3 680 681 #define BUS_PCI 0x01 682 #define BUS_ISAPNP 0x02 683 #define BUS_USB 0x03 684 #define BUS_HIL 0x04 685 #define BUS_BLUETOOTH 0x05 686 #define BUS_VIRTUAL 0x06 687 688 #define BUS_ISA 0x10 689 #define BUS_I8042 0x11 690 #define BUS_XTKBD 0x12 691 #define BUS_RS232 0x13 692 #define BUS_GAMEPORT 0x14 693 #define BUS_PARPORT 0x15 694 #define BUS_AMIGA 0x16 695 #define BUS_ADB 0x17 696 #define BUS_I2C 0x18 697 #define BUS_HOST 0x19 698 #define BUS_GSC 0x1A 699 #define BUS_ATARI 0x1B 700 701 /* 702 * Values describing the status of a force-feedback effect 703 */ 704 #define FF_STATUS_STOPPED 0x00 705 #define FF_STATUS_PLAYING 0x01 706 #define FF_STATUS_MAX 0x01 707 708 /* 709 * Structures used in ioctls to upload effects to a device 710 * They are pieces of a bigger structure (called ff_effect) 711 */ 712 713 /* 714 * All duration values are expressed in ms. Values above 32767 ms (0x7fff) 715 * should not be used and have unspecified results. 716 */ 717 718 /** 719 * struct ff_replay - defines scheduling of the force-feedback effect 720 * @length: duration of the effect 721 * @delay: delay before effect should start playing 722 */ 723 struct ff_replay { 724 __u16 length; 725 __u16 delay; 726 }; 727 728 /** 729 * struct ff_trigger - defines what triggers the force-feedback effect 730 * @button: number of the button triggering the effect 731 * @interval: controls how soon the effect can be re-triggered 732 */ 733 struct ff_trigger { 734 __u16 button; 735 __u16 interval; 736 }; 737 738 /** 739 * struct ff_envelope - generic force-feedback effect envelope 740 * @attack_length: duration of the attack (ms) 741 * @attack_level: level at the beginning of the attack 742 * @fade_length: duration of fade (ms) 743 * @fade_level: level at the end of fade 744 * 745 * The @attack_level and @fade_level are absolute values; when applying 746 * envelope force-feedback core will convert to positive/negative 747 * value based on polarity of the default level of the effect. 748 * Valid range for the attack and fade levels is 0x0000 - 0x7fff 749 */ 750 struct ff_envelope { 751 __u16 attack_length; 752 __u16 attack_level; 753 __u16 fade_length; 754 __u16 fade_level; 755 }; 756 757 /** 758 * struct ff_constant_effect - defines parameters of a constant force-feedback effect 759 * @level: strength of the effect; may be negative 760 * @envelope: envelope data 761 */ 762 struct ff_constant_effect { 763 __s16 level; 764 struct ff_envelope envelope; 765 }; 766 767 /** 768 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect 769 * @start_level: beginning strength of the effect; may be negative 770 * @end_level: final strength of the effect; may be negative 771 * @envelope: envelope data 772 */ 773 struct ff_ramp_effect { 774 __s16 start_level; 775 __s16 end_level; 776 struct ff_envelope envelope; 777 }; 778 779 /** 780 * struct ff_condition_effect - defines a spring or friction force-feedback effect 781 * @right_saturation: maximum level when joystick moved all way to the right 782 * @left_saturation: same for the left side 783 * @right_coeff: controls how fast the force grows when the joystick moves 784 * to the right 785 * @left_coeff: same for the left side 786 * @deadband: size of the dead zone, where no force is produced 787 * @center: position of the dead zone 788 */ 789 struct ff_condition_effect { 790 __u16 right_saturation; 791 __u16 left_saturation; 792 793 __s16 right_coeff; 794 __s16 left_coeff; 795 796 __u16 deadband; 797 __s16 center; 798 }; 799 800 /** 801 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect 802 * @waveform: kind of the effect (wave) 803 * @period: period of the wave (ms) 804 * @magnitude: peak value 805 * @offset: mean value of the wave (roughly) 806 * @phase: 'horizontal' shift 807 * @envelope: envelope data 808 * @custom_len: number of samples (FF_CUSTOM only) 809 * @custom_data: buffer of samples (FF_CUSTOM only) 810 * 811 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, 812 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined 813 * for the time being as no driver supports it yet. 814 * 815 * Note: the data pointed by custom_data is copied by the driver. 816 * You can therefore dispose of the memory after the upload/update. 817 */ 818 struct ff_periodic_effect { 819 __u16 waveform; 820 __u16 period; 821 __s16 magnitude; 822 __s16 offset; 823 __u16 phase; 824 825 struct ff_envelope envelope; 826 827 __u32 custom_len; 828 __s16 *custom_data; 829 }; 830 831 /** 832 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect 833 * @strong_magnitude: magnitude of the heavy motor 834 * @weak_magnitude: magnitude of the light one 835 * 836 * Some rumble pads have two motors of different weight. Strong_magnitude 837 * represents the magnitude of the vibration generated by the heavy one. 838 */ 839 struct ff_rumble_effect { 840 __u16 strong_magnitude; 841 __u16 weak_magnitude; 842 }; 843 844 /** 845 * struct ff_effect - defines force feedback effect 846 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING, 847 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM) 848 * @id: an unique id assigned to an effect 849 * @direction: direction of the effect 850 * @trigger: trigger conditions (struct ff_trigger) 851 * @replay: scheduling of the effect (struct ff_replay) 852 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect, 853 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further 854 * defining effect parameters 855 * 856 * This structure is sent through ioctl from the application to the driver. 857 * To create a new effect aplication should set its @id to -1; the kernel 858 * will return assigned @id which can later be used to update or delete 859 * this effect. 860 * 861 * Direction of the effect is encoded as follows: 862 * 0 deg -> 0x0000 (down) 863 * 90 deg -> 0x4000 (left) 864 * 180 deg -> 0x8000 (up) 865 * 270 deg -> 0xC000 (right) 866 */ 867 struct ff_effect { 868 __u16 type; 869 __s16 id; 870 __u16 direction; 871 struct ff_trigger trigger; 872 struct ff_replay replay; 873 874 union { 875 struct ff_constant_effect constant; 876 struct ff_ramp_effect ramp; 877 struct ff_periodic_effect periodic; 878 struct ff_condition_effect condition[2]; /* One for each axis */ 879 struct ff_rumble_effect rumble; 880 } u; 881 }; 882 883 /* 884 * Force feedback effect types 885 */ 886 887 #define FF_RUMBLE 0x50 888 #define FF_PERIODIC 0x51 889 #define FF_CONSTANT 0x52 890 #define FF_SPRING 0x53 891 #define FF_FRICTION 0x54 892 #define FF_DAMPER 0x55 893 #define FF_INERTIA 0x56 894 #define FF_RAMP 0x57 895 896 #define FF_EFFECT_MIN FF_RUMBLE 897 #define FF_EFFECT_MAX FF_RAMP 898 899 /* 900 * Force feedback periodic effect types 901 */ 902 903 #define FF_SQUARE 0x58 904 #define FF_TRIANGLE 0x59 905 #define FF_SINE 0x5a 906 #define FF_SAW_UP 0x5b 907 #define FF_SAW_DOWN 0x5c 908 #define FF_CUSTOM 0x5d 909 910 #define FF_WAVEFORM_MIN FF_SQUARE 911 #define FF_WAVEFORM_MAX FF_CUSTOM 912 913 /* 914 * Set ff device properties 915 */ 916 917 #define FF_GAIN 0x60 918 #define FF_AUTOCENTER 0x61 919 920 #define FF_MAX 0x7f 921 922 #ifdef __KERNEL__ 923 924 /* 925 * In-kernel definitions. 926 */ 927 928 #include <linux/device.h> 929 #include <linux/fs.h> 930 #include <linux/timer.h> 931 #include <linux/mod_devicetable.h> 932 933 #define NBITS(x) (((x)/BITS_PER_LONG)+1) 934 #define BIT(x) (1UL<<((x)%BITS_PER_LONG)) 935 #define LONG(x) ((x)/BITS_PER_LONG) 936 937 struct input_dev { 938 939 void *private; 940 941 const char *name; 942 const char *phys; 943 const char *uniq; 944 struct input_id id; 945 946 unsigned long evbit[NBITS(EV_MAX)]; 947 unsigned long keybit[NBITS(KEY_MAX)]; 948 unsigned long relbit[NBITS(REL_MAX)]; 949 unsigned long absbit[NBITS(ABS_MAX)]; 950 unsigned long mscbit[NBITS(MSC_MAX)]; 951 unsigned long ledbit[NBITS(LED_MAX)]; 952 unsigned long sndbit[NBITS(SND_MAX)]; 953 unsigned long ffbit[NBITS(FF_MAX)]; 954 unsigned long swbit[NBITS(SW_MAX)]; 955 956 unsigned int keycodemax; 957 unsigned int keycodesize; 958 void *keycode; 959 int (*setkeycode)(struct input_dev *dev, int scancode, int keycode); 960 int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode); 961 962 struct ff_device *ff; 963 964 unsigned int repeat_key; 965 struct timer_list timer; 966 967 int state; 968 969 int sync; 970 971 int abs[ABS_MAX + 1]; 972 int rep[REP_MAX + 1]; 973 974 unsigned long key[NBITS(KEY_MAX)]; 975 unsigned long led[NBITS(LED_MAX)]; 976 unsigned long snd[NBITS(SND_MAX)]; 977 unsigned long sw[NBITS(SW_MAX)]; 978 979 int absmax[ABS_MAX + 1]; 980 int absmin[ABS_MAX + 1]; 981 int absfuzz[ABS_MAX + 1]; 982 int absflat[ABS_MAX + 1]; 983 984 int (*open)(struct input_dev *dev); 985 void (*close)(struct input_dev *dev); 986 int (*flush)(struct input_dev *dev, struct file *file); 987 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value); 988 989 struct input_handle *grab; 990 991 struct mutex mutex; /* serializes open and close operations */ 992 unsigned int users; 993 994 struct device dev; 995 union { /* temporarily so while we switching to struct device */ 996 struct device *dev; 997 } cdev; 998 999 struct list_head h_list; 1000 struct list_head node; 1001 }; 1002 #define to_input_dev(d) container_of(d, struct input_dev, dev) 1003 1004 /* 1005 * Verify that we are in sync with input_device_id mod_devicetable.h #defines 1006 */ 1007 1008 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX 1009 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match" 1010 #endif 1011 1012 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING 1013 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match" 1014 #endif 1015 1016 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX 1017 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match" 1018 #endif 1019 1020 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX 1021 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match" 1022 #endif 1023 1024 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX 1025 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match" 1026 #endif 1027 1028 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX 1029 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match" 1030 #endif 1031 1032 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX 1033 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match" 1034 #endif 1035 1036 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX 1037 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match" 1038 #endif 1039 1040 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX 1041 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match" 1042 #endif 1043 1044 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX 1045 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match" 1046 #endif 1047 1048 #define INPUT_DEVICE_ID_MATCH_DEVICE \ 1049 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT) 1050 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \ 1051 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION) 1052 1053 struct input_handle; 1054 1055 /** 1056 * struct input_handler - implements one of interfaces for input devices 1057 * @private: driver-specific data 1058 * @event: event handler 1059 * @connect: called when attaching a handler to an input device 1060 * @disconnect: disconnects a handler from input device 1061 * @start: starts handler for given handle. This function is called by 1062 * input core right after connect() method and also when a process 1063 * that "grabbed" a device releases it 1064 * @fops: file operations this driver implements 1065 * @minor: beginning of range of 32 minors for devices this driver 1066 * can provide 1067 * @name: name of the handler, to be shown in /proc/bus/input/handlers 1068 * @id_table: pointer to a table of input_device_ids this driver can 1069 * handle 1070 * @blacklist: prointer to a table of input_device_ids this driver should 1071 * ignore even if they match @id_table 1072 * @h_list: list of input handles associated with the handler 1073 * @node: for placing the driver onto input_handler_list 1074 */ 1075 struct input_handler { 1076 1077 void *private; 1078 1079 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value); 1080 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id); 1081 void (*disconnect)(struct input_handle *handle); 1082 void (*start)(struct input_handle *handle); 1083 1084 const struct file_operations *fops; 1085 int minor; 1086 const char *name; 1087 1088 const struct input_device_id *id_table; 1089 const struct input_device_id *blacklist; 1090 1091 struct list_head h_list; 1092 struct list_head node; 1093 }; 1094 1095 struct input_handle { 1096 1097 void *private; 1098 1099 int open; 1100 const char *name; 1101 1102 struct input_dev *dev; 1103 struct input_handler *handler; 1104 1105 struct list_head d_node; 1106 struct list_head h_node; 1107 }; 1108 1109 #define to_dev(n) container_of(n, struct input_dev, node) 1110 #define to_handler(n) container_of(n, struct input_handler, node) 1111 #define to_handle(n) container_of(n, struct input_handle, d_node) 1112 #define to_handle_h(n) container_of(n, struct input_handle, h_node) 1113 1114 struct input_dev *input_allocate_device(void); 1115 void input_free_device(struct input_dev *dev); 1116 1117 static inline struct input_dev *input_get_device(struct input_dev *dev) 1118 { 1119 return to_input_dev(get_device(&dev->dev)); 1120 } 1121 1122 static inline void input_put_device(struct input_dev *dev) 1123 { 1124 put_device(&dev->dev); 1125 } 1126 1127 static inline void *input_get_drvdata(struct input_dev *dev) 1128 { 1129 return dev->private; 1130 } 1131 1132 static inline void input_set_drvdata(struct input_dev *dev, void *data) 1133 { 1134 dev->private = data; 1135 } 1136 1137 int input_register_device(struct input_dev *); 1138 void input_unregister_device(struct input_dev *); 1139 1140 int input_register_handler(struct input_handler *); 1141 void input_unregister_handler(struct input_handler *); 1142 1143 int input_register_handle(struct input_handle *); 1144 void input_unregister_handle(struct input_handle *); 1145 1146 int input_grab_device(struct input_handle *); 1147 void input_release_device(struct input_handle *); 1148 1149 int input_open_device(struct input_handle *); 1150 void input_close_device(struct input_handle *); 1151 1152 int input_flush_device(struct input_handle* handle, struct file* file); 1153 1154 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value); 1155 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value); 1156 1157 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value) 1158 { 1159 input_event(dev, EV_KEY, code, !!value); 1160 } 1161 1162 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value) 1163 { 1164 input_event(dev, EV_REL, code, value); 1165 } 1166 1167 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value) 1168 { 1169 input_event(dev, EV_ABS, code, value); 1170 } 1171 1172 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value) 1173 { 1174 input_event(dev, EV_FF_STATUS, code, value); 1175 } 1176 1177 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value) 1178 { 1179 input_event(dev, EV_SW, code, !!value); 1180 } 1181 1182 static inline void input_sync(struct input_dev *dev) 1183 { 1184 input_event(dev, EV_SYN, SYN_REPORT, 0); 1185 } 1186 1187 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code); 1188 1189 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat) 1190 { 1191 dev->absmin[axis] = min; 1192 dev->absmax[axis] = max; 1193 dev->absfuzz[axis] = fuzz; 1194 dev->absflat[axis] = flat; 1195 1196 dev->absbit[LONG(axis)] |= BIT(axis); 1197 } 1198 1199 extern struct class input_class; 1200 1201 /** 1202 * struct ff_device - force-feedback part of an input device 1203 * @upload: Called to upload an new effect into device 1204 * @erase: Called to erase an effect from device 1205 * @playback: Called to request device to start playing specified effect 1206 * @set_gain: Called to set specified gain 1207 * @set_autocenter: Called to auto-center device 1208 * @destroy: called by input core when parent input device is being 1209 * destroyed 1210 * @private: driver-specific data, will be freed automatically 1211 * @ffbit: bitmap of force feedback capabilities truly supported by 1212 * device (not emulated like ones in input_dev->ffbit) 1213 * @mutex: mutex for serializing access to the device 1214 * @max_effects: maximum number of effects supported by device 1215 * @effects: pointer to an array of effects currently loaded into device 1216 * @effect_owners: array of effect owners; when file handle owning 1217 * an effect gets closed the effcet is automatically erased 1218 * 1219 * Every force-feedback device must implement upload() and playback() 1220 * methods; erase() is optional. set_gain() and set_autocenter() need 1221 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER 1222 * bits. 1223 */ 1224 struct ff_device { 1225 int (*upload)(struct input_dev *dev, struct ff_effect *effect, 1226 struct ff_effect *old); 1227 int (*erase)(struct input_dev *dev, int effect_id); 1228 1229 int (*playback)(struct input_dev *dev, int effect_id, int value); 1230 void (*set_gain)(struct input_dev *dev, u16 gain); 1231 void (*set_autocenter)(struct input_dev *dev, u16 magnitude); 1232 1233 void (*destroy)(struct ff_device *); 1234 1235 void *private; 1236 1237 unsigned long ffbit[NBITS(FF_MAX)]; 1238 1239 struct mutex mutex; 1240 1241 int max_effects; 1242 struct ff_effect *effects; 1243 struct file *effect_owners[]; 1244 }; 1245 1246 int input_ff_create(struct input_dev *dev, int max_effects); 1247 void input_ff_destroy(struct input_dev *dev); 1248 1249 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value); 1250 1251 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file); 1252 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file); 1253 1254 int input_ff_create_memless(struct input_dev *dev, void *data, 1255 int (*play_effect)(struct input_dev *, void *, struct ff_effect *)); 1256 1257 #endif 1258 #endif 1259