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