1 /* 2 * Copyright (c) 1999 Andreas Gal 3 * Copyright (c) 2000-2001 Vojtech Pavlik 4 * Copyright (c) 2006-2007 Jiri Kosina 5 */ 6 /* 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20 * 21 * Should you need to contact me, the author, you can do so either by 22 * e-mail - mail your message to <[email protected]>, or by paper mail: 23 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic 24 */ 25 #ifndef __HID_H 26 #define __HID_H 27 28 29 #include <linux/bitops.h> 30 #include <linux/types.h> 31 #include <linux/slab.h> 32 #include <linux/list.h> 33 #include <linux/mod_devicetable.h> /* hid_device_id */ 34 #include <linux/timer.h> 35 #include <linux/workqueue.h> 36 #include <linux/input.h> 37 #include <linux/semaphore.h> 38 #include <linux/mutex.h> 39 #include <linux/power_supply.h> 40 #include <uapi/linux/hid.h> 41 42 /* 43 * We parse each description item into this structure. Short items data 44 * values are expanded to 32-bit signed int, long items contain a pointer 45 * into the data area. 46 */ 47 48 struct hid_item { 49 unsigned format; 50 __u8 size; 51 __u8 type; 52 __u8 tag; 53 union { 54 __u8 u8; 55 __s8 s8; 56 __u16 u16; 57 __s16 s16; 58 __u32 u32; 59 __s32 s32; 60 __u8 *longdata; 61 } data; 62 }; 63 64 /* 65 * HID report item format 66 */ 67 68 #define HID_ITEM_FORMAT_SHORT 0 69 #define HID_ITEM_FORMAT_LONG 1 70 71 /* 72 * Special tag indicating long items 73 */ 74 75 #define HID_ITEM_TAG_LONG 15 76 77 /* 78 * HID report descriptor item type (prefix bit 2,3) 79 */ 80 81 #define HID_ITEM_TYPE_MAIN 0 82 #define HID_ITEM_TYPE_GLOBAL 1 83 #define HID_ITEM_TYPE_LOCAL 2 84 #define HID_ITEM_TYPE_RESERVED 3 85 86 /* 87 * HID report descriptor main item tags 88 */ 89 90 #define HID_MAIN_ITEM_TAG_INPUT 8 91 #define HID_MAIN_ITEM_TAG_OUTPUT 9 92 #define HID_MAIN_ITEM_TAG_FEATURE 11 93 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10 94 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12 95 96 /* 97 * HID report descriptor main item contents 98 */ 99 100 #define HID_MAIN_ITEM_CONSTANT 0x001 101 #define HID_MAIN_ITEM_VARIABLE 0x002 102 #define HID_MAIN_ITEM_RELATIVE 0x004 103 #define HID_MAIN_ITEM_WRAP 0x008 104 #define HID_MAIN_ITEM_NONLINEAR 0x010 105 #define HID_MAIN_ITEM_NO_PREFERRED 0x020 106 #define HID_MAIN_ITEM_NULL_STATE 0x040 107 #define HID_MAIN_ITEM_VOLATILE 0x080 108 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 109 110 /* 111 * HID report descriptor collection item types 112 */ 113 114 #define HID_COLLECTION_PHYSICAL 0 115 #define HID_COLLECTION_APPLICATION 1 116 #define HID_COLLECTION_LOGICAL 2 117 118 /* 119 * HID report descriptor global item tags 120 */ 121 122 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0 123 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1 124 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2 125 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3 126 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4 127 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5 128 #define HID_GLOBAL_ITEM_TAG_UNIT 6 129 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7 130 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8 131 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9 132 #define HID_GLOBAL_ITEM_TAG_PUSH 10 133 #define HID_GLOBAL_ITEM_TAG_POP 11 134 135 /* 136 * HID report descriptor local item tags 137 */ 138 139 #define HID_LOCAL_ITEM_TAG_USAGE 0 140 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1 141 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2 142 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3 143 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4 144 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5 145 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7 146 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8 147 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9 148 #define HID_LOCAL_ITEM_TAG_DELIMITER 10 149 150 /* 151 * HID usage tables 152 */ 153 154 #define HID_USAGE_PAGE 0xffff0000 155 156 #define HID_UP_UNDEFINED 0x00000000 157 #define HID_UP_GENDESK 0x00010000 158 #define HID_UP_SIMULATION 0x00020000 159 #define HID_UP_GENDEVCTRLS 0x00060000 160 #define HID_UP_KEYBOARD 0x00070000 161 #define HID_UP_LED 0x00080000 162 #define HID_UP_BUTTON 0x00090000 163 #define HID_UP_ORDINAL 0x000a0000 164 #define HID_UP_TELEPHONY 0x000b0000 165 #define HID_UP_CONSUMER 0x000c0000 166 #define HID_UP_DIGITIZER 0x000d0000 167 #define HID_UP_PID 0x000f0000 168 #define HID_UP_HPVENDOR 0xff7f0000 169 #define HID_UP_HPVENDOR2 0xff010000 170 #define HID_UP_MSVENDOR 0xff000000 171 #define HID_UP_CUSTOM 0x00ff0000 172 #define HID_UP_LOGIVENDOR 0xffbc0000 173 #define HID_UP_LOGIVENDOR2 0xff090000 174 #define HID_UP_LOGIVENDOR3 0xff430000 175 #define HID_UP_LNVENDOR 0xffa00000 176 #define HID_UP_SENSOR 0x00200000 177 #define HID_UP_ASUSVENDOR 0xff310000 178 179 #define HID_USAGE 0x0000ffff 180 181 #define HID_GD_POINTER 0x00010001 182 #define HID_GD_MOUSE 0x00010002 183 #define HID_GD_JOYSTICK 0x00010004 184 #define HID_GD_GAMEPAD 0x00010005 185 #define HID_GD_KEYBOARD 0x00010006 186 #define HID_GD_KEYPAD 0x00010007 187 #define HID_GD_MULTIAXIS 0x00010008 188 /* 189 * Microsoft Win8 Wireless Radio Controls extensions CA, see: 190 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf 191 */ 192 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c 193 #define HID_GD_X 0x00010030 194 #define HID_GD_Y 0x00010031 195 #define HID_GD_Z 0x00010032 196 #define HID_GD_RX 0x00010033 197 #define HID_GD_RY 0x00010034 198 #define HID_GD_RZ 0x00010035 199 #define HID_GD_SLIDER 0x00010036 200 #define HID_GD_DIAL 0x00010037 201 #define HID_GD_WHEEL 0x00010038 202 #define HID_GD_HATSWITCH 0x00010039 203 #define HID_GD_BUFFER 0x0001003a 204 #define HID_GD_BYTECOUNT 0x0001003b 205 #define HID_GD_MOTION 0x0001003c 206 #define HID_GD_START 0x0001003d 207 #define HID_GD_SELECT 0x0001003e 208 #define HID_GD_VX 0x00010040 209 #define HID_GD_VY 0x00010041 210 #define HID_GD_VZ 0x00010042 211 #define HID_GD_VBRX 0x00010043 212 #define HID_GD_VBRY 0x00010044 213 #define HID_GD_VBRZ 0x00010045 214 #define HID_GD_VNO 0x00010046 215 #define HID_GD_FEATURE 0x00010047 216 #define HID_GD_SYSTEM_CONTROL 0x00010080 217 #define HID_GD_UP 0x00010090 218 #define HID_GD_DOWN 0x00010091 219 #define HID_GD_RIGHT 0x00010092 220 #define HID_GD_LEFT 0x00010093 221 /* Microsoft Win8 Wireless Radio Controls CA usage codes */ 222 #define HID_GD_RFKILL_BTN 0x000100c6 223 #define HID_GD_RFKILL_LED 0x000100c7 224 #define HID_GD_RFKILL_SWITCH 0x000100c8 225 226 #define HID_DC_BATTERYSTRENGTH 0x00060020 227 228 #define HID_CP_CONSUMER_CONTROL 0x000c0001 229 230 #define HID_DG_DIGITIZER 0x000d0001 231 #define HID_DG_PEN 0x000d0002 232 #define HID_DG_LIGHTPEN 0x000d0003 233 #define HID_DG_TOUCHSCREEN 0x000d0004 234 #define HID_DG_TOUCHPAD 0x000d0005 235 #define HID_DG_STYLUS 0x000d0020 236 #define HID_DG_PUCK 0x000d0021 237 #define HID_DG_FINGER 0x000d0022 238 #define HID_DG_TIPPRESSURE 0x000d0030 239 #define HID_DG_BARRELPRESSURE 0x000d0031 240 #define HID_DG_INRANGE 0x000d0032 241 #define HID_DG_TOUCH 0x000d0033 242 #define HID_DG_UNTOUCH 0x000d0034 243 #define HID_DG_TAP 0x000d0035 244 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 245 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a 246 #define HID_DG_BATTERYSTRENGTH 0x000d003b 247 #define HID_DG_INVERT 0x000d003c 248 #define HID_DG_TILT_X 0x000d003d 249 #define HID_DG_TILT_Y 0x000d003e 250 #define HID_DG_TWIST 0x000d0041 251 #define HID_DG_TIPSWITCH 0x000d0042 252 #define HID_DG_TIPSWITCH2 0x000d0043 253 #define HID_DG_BARRELSWITCH 0x000d0044 254 #define HID_DG_ERASER 0x000d0045 255 #define HID_DG_TABLETPICK 0x000d0046 256 257 #define HID_CP_CONSUMERCONTROL 0x000c0001 258 #define HID_CP_NUMERICKEYPAD 0x000c0002 259 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003 260 #define HID_CP_MICROPHONE 0x000c0004 261 #define HID_CP_HEADPHONE 0x000c0005 262 #define HID_CP_GRAPHICEQUALIZER 0x000c0006 263 #define HID_CP_FUNCTIONBUTTONS 0x000c0036 264 #define HID_CP_SELECTION 0x000c0080 265 #define HID_CP_MEDIASELECTION 0x000c0087 266 #define HID_CP_SELECTDISC 0x000c00ba 267 #define HID_CP_PLAYBACKSPEED 0x000c00f1 268 #define HID_CP_PROXIMITY 0x000c0109 269 #define HID_CP_SPEAKERSYSTEM 0x000c0160 270 #define HID_CP_CHANNELLEFT 0x000c0161 271 #define HID_CP_CHANNELRIGHT 0x000c0162 272 #define HID_CP_CHANNELCENTER 0x000c0163 273 #define HID_CP_CHANNELFRONT 0x000c0164 274 #define HID_CP_CHANNELCENTERFRONT 0x000c0165 275 #define HID_CP_CHANNELSIDE 0x000c0166 276 #define HID_CP_CHANNELSURROUND 0x000c0167 277 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168 278 #define HID_CP_CHANNELTOP 0x000c0169 279 #define HID_CP_CHANNELUNKNOWN 0x000c016a 280 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180 281 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200 282 283 #define HID_DG_DEVICECONFIG 0x000d000e 284 #define HID_DG_DEVICESETTINGS 0x000d0023 285 #define HID_DG_AZIMUTH 0x000d003f 286 #define HID_DG_CONFIDENCE 0x000d0047 287 #define HID_DG_WIDTH 0x000d0048 288 #define HID_DG_HEIGHT 0x000d0049 289 #define HID_DG_CONTACTID 0x000d0051 290 #define HID_DG_INPUTMODE 0x000d0052 291 #define HID_DG_DEVICEINDEX 0x000d0053 292 #define HID_DG_CONTACTCOUNT 0x000d0054 293 #define HID_DG_CONTACTMAX 0x000d0055 294 #define HID_DG_SCANTIME 0x000d0056 295 #define HID_DG_BUTTONTYPE 0x000d0059 296 #define HID_DG_BARRELSWITCH2 0x000d005a 297 #define HID_DG_TOOLSERIALNUMBER 0x000d005b 298 299 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076 300 /* 301 * HID report types --- Ouch! HID spec says 1 2 3! 302 */ 303 304 #define HID_INPUT_REPORT 0 305 #define HID_OUTPUT_REPORT 1 306 #define HID_FEATURE_REPORT 2 307 308 #define HID_REPORT_TYPES 3 309 310 /* 311 * HID connect requests 312 */ 313 314 #define HID_CONNECT_HIDINPUT BIT(0) 315 #define HID_CONNECT_HIDINPUT_FORCE BIT(1) 316 #define HID_CONNECT_HIDRAW BIT(2) 317 #define HID_CONNECT_HIDDEV BIT(3) 318 #define HID_CONNECT_HIDDEV_FORCE BIT(4) 319 #define HID_CONNECT_FF BIT(5) 320 #define HID_CONNECT_DRIVER BIT(6) 321 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ 322 HID_CONNECT_HIDDEV|HID_CONNECT_FF) 323 324 /* 325 * HID device quirks. 326 */ 327 328 /* 329 * Increase this if you need to configure more HID quirks at module load time 330 */ 331 #define MAX_USBHID_BOOT_QUIRKS 4 332 333 #define HID_QUIRK_INVERT BIT(0) 334 #define HID_QUIRK_NOTOUCH BIT(1) 335 #define HID_QUIRK_IGNORE BIT(2) 336 #define HID_QUIRK_NOGET BIT(3) 337 #define HID_QUIRK_HIDDEV_FORCE BIT(4) 338 #define HID_QUIRK_BADPAD BIT(5) 339 #define HID_QUIRK_MULTI_INPUT BIT(6) 340 #define HID_QUIRK_HIDINPUT_FORCE BIT(7) 341 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */ 342 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */ 343 #define HID_QUIRK_ALWAYS_POLL BIT(10) 344 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16) 345 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17) 346 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18) 347 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19) 348 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28) 349 #define HID_QUIRK_NO_INIT_REPORTS BIT(29) 350 #define HID_QUIRK_NO_IGNORE BIT(30) 351 #define HID_QUIRK_NO_INPUT_SYNC BIT(31) 352 353 /* 354 * HID device groups 355 * 356 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h 357 * and has a value of 0x0000 358 */ 359 #define HID_GROUP_GENERIC 0x0001 360 #define HID_GROUP_MULTITOUCH 0x0002 361 #define HID_GROUP_SENSOR_HUB 0x0003 362 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 363 364 /* 365 * Vendor specific HID device groups 366 */ 367 #define HID_GROUP_RMI 0x0100 368 #define HID_GROUP_WACOM 0x0101 369 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102 370 371 /* 372 * HID protocol status 373 */ 374 #define HID_REPORT_PROTOCOL 1 375 #define HID_BOOT_PROTOCOL 0 376 377 /* 378 * This is the global environment of the parser. This information is 379 * persistent for main-items. The global environment can be saved and 380 * restored with PUSH/POP statements. 381 */ 382 383 struct hid_global { 384 unsigned usage_page; 385 __s32 logical_minimum; 386 __s32 logical_maximum; 387 __s32 physical_minimum; 388 __s32 physical_maximum; 389 __s32 unit_exponent; 390 unsigned unit; 391 unsigned report_id; 392 unsigned report_size; 393 unsigned report_count; 394 }; 395 396 /* 397 * This is the local environment. It is persistent up the next main-item. 398 */ 399 400 #define HID_MAX_USAGES 12288 401 #define HID_DEFAULT_NUM_COLLECTIONS 16 402 403 struct hid_local { 404 unsigned usage[HID_MAX_USAGES]; /* usage array */ 405 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ 406 unsigned usage_index; 407 unsigned usage_minimum; 408 unsigned delimiter_depth; 409 unsigned delimiter_branch; 410 }; 411 412 /* 413 * This is the collection stack. We climb up the stack to determine 414 * application and function of each field. 415 */ 416 417 struct hid_collection { 418 unsigned type; 419 unsigned usage; 420 unsigned level; 421 }; 422 423 struct hid_usage { 424 unsigned hid; /* hid usage code */ 425 unsigned collection_index; /* index into collection array */ 426 unsigned usage_index; /* index into usage array */ 427 /* hidinput data */ 428 __u16 code; /* input driver code */ 429 __u8 type; /* input driver type */ 430 __s8 hat_min; /* hat switch fun */ 431 __s8 hat_max; /* ditto */ 432 __s8 hat_dir; /* ditto */ 433 }; 434 435 struct hid_input; 436 437 struct hid_field { 438 unsigned physical; /* physical usage for this field */ 439 unsigned logical; /* logical usage for this field */ 440 unsigned application; /* application usage for this field */ 441 struct hid_usage *usage; /* usage table for this function */ 442 unsigned maxusage; /* maximum usage index */ 443 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ 444 unsigned report_offset; /* bit offset in the report */ 445 unsigned report_size; /* size of this field in the report */ 446 unsigned report_count; /* number of this field in the report */ 447 unsigned report_type; /* (input,output,feature) */ 448 __s32 *value; /* last known value(s) */ 449 __s32 logical_minimum; 450 __s32 logical_maximum; 451 __s32 physical_minimum; 452 __s32 physical_maximum; 453 __s32 unit_exponent; 454 unsigned unit; 455 struct hid_report *report; /* associated report */ 456 unsigned index; /* index into report->field[] */ 457 /* hidinput data */ 458 struct hid_input *hidinput; /* associated input structure */ 459 __u16 dpad; /* dpad input code */ 460 }; 461 462 #define HID_MAX_FIELDS 256 463 464 struct hid_report { 465 struct list_head list; 466 unsigned id; /* id of this report */ 467 unsigned type; /* report type */ 468 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ 469 unsigned maxfield; /* maximum valid field index */ 470 unsigned size; /* size of the report (bits) */ 471 struct hid_device *device; /* associated device */ 472 }; 473 474 #define HID_MAX_IDS 256 475 476 struct hid_report_enum { 477 unsigned numbered; 478 struct list_head report_list; 479 struct hid_report *report_id_hash[HID_MAX_IDS]; 480 }; 481 482 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ 483 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ 484 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ 485 #define HID_OUTPUT_FIFO_SIZE 64 486 487 struct hid_control_fifo { 488 unsigned char dir; 489 struct hid_report *report; 490 char *raw_report; 491 }; 492 493 struct hid_output_fifo { 494 struct hid_report *report; 495 char *raw_report; 496 }; 497 498 #define HID_CLAIMED_INPUT BIT(0) 499 #define HID_CLAIMED_HIDDEV BIT(1) 500 #define HID_CLAIMED_HIDRAW BIT(2) 501 #define HID_CLAIMED_DRIVER BIT(3) 502 503 #define HID_STAT_ADDED BIT(0) 504 #define HID_STAT_PARSED BIT(1) 505 506 struct hid_input { 507 struct list_head list; 508 struct hid_report *report; 509 struct input_dev *input; 510 bool registered; 511 }; 512 513 enum hid_type { 514 HID_TYPE_OTHER = 0, 515 HID_TYPE_USBMOUSE, 516 HID_TYPE_USBNONE 517 }; 518 519 struct hid_driver; 520 struct hid_ll_driver; 521 522 struct hid_device { /* device report descriptor */ 523 __u8 *dev_rdesc; 524 unsigned dev_rsize; 525 __u8 *rdesc; 526 unsigned rsize; 527 struct hid_collection *collection; /* List of HID collections */ 528 unsigned collection_size; /* Number of allocated hid_collections */ 529 unsigned maxcollection; /* Number of parsed collections */ 530 unsigned maxapplication; /* Number of applications */ 531 __u16 bus; /* BUS ID */ 532 __u16 group; /* Report group */ 533 __u32 vendor; /* Vendor ID */ 534 __u32 product; /* Product ID */ 535 __u32 version; /* HID version */ 536 enum hid_type type; /* device type (mouse, kbd, ...) */ 537 unsigned country; /* HID country */ 538 struct hid_report_enum report_enum[HID_REPORT_TYPES]; 539 struct work_struct led_work; /* delayed LED worker */ 540 541 struct semaphore driver_input_lock; /* protects the current driver */ 542 struct device dev; /* device */ 543 struct hid_driver *driver; 544 545 struct hid_ll_driver *ll_driver; 546 struct mutex ll_open_lock; 547 unsigned int ll_open_count; 548 549 #ifdef CONFIG_HID_BATTERY_STRENGTH 550 /* 551 * Power supply information for HID devices which report 552 * battery strength. power_supply was successfully registered if 553 * battery is non-NULL. 554 */ 555 struct power_supply *battery; 556 __s32 battery_capacity; 557 __s32 battery_min; 558 __s32 battery_max; 559 __s32 battery_report_type; 560 __s32 battery_report_id; 561 bool battery_reported; 562 #endif 563 564 unsigned int status; /* see STAT flags above */ 565 unsigned claimed; /* Claimed by hidinput, hiddev? */ 566 unsigned quirks; /* Various quirks the device can pull on us */ 567 bool io_started; /* If IO has started */ 568 569 struct list_head inputs; /* The list of inputs */ 570 void *hiddev; /* The hiddev structure */ 571 void *hidraw; 572 573 char name[128]; /* Device name */ 574 char phys[64]; /* Device physical location */ 575 char uniq[64]; /* Device unique identifier (serial #) */ 576 577 void *driver_data; 578 579 /* temporary hid_ff handling (until moved to the drivers) */ 580 int (*ff_init)(struct hid_device *); 581 582 /* hiddev event handler */ 583 int (*hiddev_connect)(struct hid_device *, unsigned int); 584 void (*hiddev_disconnect)(struct hid_device *); 585 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, 586 struct hid_usage *, __s32); 587 void (*hiddev_report_event) (struct hid_device *, struct hid_report *); 588 589 /* debugging support via debugfs */ 590 unsigned short debug; 591 struct dentry *debug_dir; 592 struct dentry *debug_rdesc; 593 struct dentry *debug_events; 594 struct list_head debug_list; 595 spinlock_t debug_list_lock; 596 wait_queue_head_t debug_wait; 597 }; 598 599 #define to_hid_device(pdev) \ 600 container_of(pdev, struct hid_device, dev) 601 602 static inline void *hid_get_drvdata(struct hid_device *hdev) 603 { 604 return dev_get_drvdata(&hdev->dev); 605 } 606 607 static inline void hid_set_drvdata(struct hid_device *hdev, void *data) 608 { 609 dev_set_drvdata(&hdev->dev, data); 610 } 611 612 #define HID_GLOBAL_STACK_SIZE 4 613 #define HID_COLLECTION_STACK_SIZE 4 614 615 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0) 616 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1) 617 #define HID_SCAN_FLAG_GD_POINTER BIT(2) 618 619 struct hid_parser { 620 struct hid_global global; 621 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; 622 unsigned global_stack_ptr; 623 struct hid_local local; 624 unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; 625 unsigned collection_stack_ptr; 626 struct hid_device *device; 627 unsigned scan_flags; 628 }; 629 630 struct hid_class_descriptor { 631 __u8 bDescriptorType; 632 __le16 wDescriptorLength; 633 } __attribute__ ((packed)); 634 635 struct hid_descriptor { 636 __u8 bLength; 637 __u8 bDescriptorType; 638 __le16 bcdHID; 639 __u8 bCountryCode; 640 __u8 bNumDescriptors; 641 642 struct hid_class_descriptor desc[1]; 643 } __attribute__ ((packed)); 644 645 #define HID_DEVICE(b, g, ven, prod) \ 646 .bus = (b), .group = (g), .vendor = (ven), .product = (prod) 647 #define HID_USB_DEVICE(ven, prod) \ 648 .bus = BUS_USB, .vendor = (ven), .product = (prod) 649 #define HID_BLUETOOTH_DEVICE(ven, prod) \ 650 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) 651 #define HID_I2C_DEVICE(ven, prod) \ 652 .bus = BUS_I2C, .vendor = (ven), .product = (prod) 653 654 #define HID_REPORT_ID(rep) \ 655 .report_type = (rep) 656 #define HID_USAGE_ID(uhid, utype, ucode) \ 657 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) 658 /* we don't want to catch types and codes equal to 0 */ 659 #define HID_TERMINATOR (HID_ANY_ID - 1) 660 661 struct hid_report_id { 662 __u32 report_type; 663 }; 664 struct hid_usage_id { 665 __u32 usage_hid; 666 __u32 usage_type; 667 __u32 usage_code; 668 }; 669 670 /** 671 * struct hid_driver 672 * @name: driver name (e.g. "Footech_bar-wheel") 673 * @id_table: which devices is this driver for (must be non-NULL for probe 674 * to be called) 675 * @dyn_list: list of dynamically added device ids 676 * @dyn_lock: lock protecting @dyn_list 677 * @match: check if the given device is handled by this driver 678 * @probe: new device inserted 679 * @remove: device removed (NULL if not a hot-plug capable driver) 680 * @report_table: on which reports to call raw_event (NULL means all) 681 * @raw_event: if report in report_table, this hook is called (NULL means nop) 682 * @usage_table: on which events to call event (NULL means all) 683 * @event: if usage in usage_table, this hook is called (NULL means nop) 684 * @report: this hook is called after parsing a report (NULL means nop) 685 * @report_fixup: called before report descriptor parsing (NULL means nop) 686 * @input_mapping: invoked on input registering before mapping an usage 687 * @input_mapped: invoked on input registering after mapping an usage 688 * @input_configured: invoked just before the device is registered 689 * @feature_mapping: invoked on feature registering 690 * @suspend: invoked on suspend (NULL means nop) 691 * @resume: invoked on resume if device was not reset (NULL means nop) 692 * @reset_resume: invoked on resume if device was reset (NULL means nop) 693 * 694 * probe should return -errno on error, or 0 on success. During probe, 695 * input will not be passed to raw_event unless hid_device_io_start is 696 * called. 697 * 698 * raw_event and event should return 0 on no action performed, 1 when no 699 * further processing should be done and negative on error 700 * 701 * input_mapping shall return a negative value to completely ignore this usage 702 * (e.g. doubled or invalid usage), zero to continue with parsing of this 703 * usage by generic code (no special handling needed) or positive to skip 704 * generic parsing (needed special handling which was done in the hook already) 705 * input_mapped shall return negative to inform the layer that this usage 706 * should not be considered for further processing or zero to notify that 707 * no processing was performed and should be done in a generic manner 708 * Both these functions may be NULL which means the same behavior as returning 709 * zero from them. 710 */ 711 struct hid_driver { 712 char *name; 713 const struct hid_device_id *id_table; 714 715 struct list_head dyn_list; 716 spinlock_t dyn_lock; 717 718 bool (*match)(struct hid_device *dev, bool ignore_special_driver); 719 int (*probe)(struct hid_device *dev, const struct hid_device_id *id); 720 void (*remove)(struct hid_device *dev); 721 722 const struct hid_report_id *report_table; 723 int (*raw_event)(struct hid_device *hdev, struct hid_report *report, 724 u8 *data, int size); 725 const struct hid_usage_id *usage_table; 726 int (*event)(struct hid_device *hdev, struct hid_field *field, 727 struct hid_usage *usage, __s32 value); 728 void (*report)(struct hid_device *hdev, struct hid_report *report); 729 730 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, 731 unsigned int *size); 732 733 int (*input_mapping)(struct hid_device *hdev, 734 struct hid_input *hidinput, struct hid_field *field, 735 struct hid_usage *usage, unsigned long **bit, int *max); 736 int (*input_mapped)(struct hid_device *hdev, 737 struct hid_input *hidinput, struct hid_field *field, 738 struct hid_usage *usage, unsigned long **bit, int *max); 739 int (*input_configured)(struct hid_device *hdev, 740 struct hid_input *hidinput); 741 void (*feature_mapping)(struct hid_device *hdev, 742 struct hid_field *field, 743 struct hid_usage *usage); 744 #ifdef CONFIG_PM 745 int (*suspend)(struct hid_device *hdev, pm_message_t message); 746 int (*resume)(struct hid_device *hdev); 747 int (*reset_resume)(struct hid_device *hdev); 748 #endif 749 /* private: */ 750 struct device_driver driver; 751 }; 752 753 #define to_hid_driver(pdrv) \ 754 container_of(pdrv, struct hid_driver, driver) 755 756 /** 757 * hid_ll_driver - low level driver callbacks 758 * @start: called on probe to start the device 759 * @stop: called on remove 760 * @open: called by input layer on open 761 * @close: called by input layer on close 762 * @power: request underlying hardware to enter requested power mode 763 * @parse: this method is called only once to parse the device data, 764 * shouldn't allocate anything to not leak memory 765 * @request: send report request to device (e.g. feature report) 766 * @wait: wait for buffered io to complete (send/recv reports) 767 * @raw_request: send raw report request to device (e.g. feature report) 768 * @output_report: send output report to device 769 * @idle: send idle request to device 770 */ 771 struct hid_ll_driver { 772 int (*start)(struct hid_device *hdev); 773 void (*stop)(struct hid_device *hdev); 774 775 int (*open)(struct hid_device *hdev); 776 void (*close)(struct hid_device *hdev); 777 778 int (*power)(struct hid_device *hdev, int level); 779 780 int (*parse)(struct hid_device *hdev); 781 782 void (*request)(struct hid_device *hdev, 783 struct hid_report *report, int reqtype); 784 785 int (*wait)(struct hid_device *hdev); 786 787 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, 788 __u8 *buf, size_t len, unsigned char rtype, 789 int reqtype); 790 791 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len); 792 793 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); 794 }; 795 796 extern struct hid_ll_driver i2c_hid_ll_driver; 797 extern struct hid_ll_driver hidp_hid_driver; 798 extern struct hid_ll_driver uhid_hid_driver; 799 extern struct hid_ll_driver usb_hid_driver; 800 801 static inline bool hid_is_using_ll_driver(struct hid_device *hdev, 802 struct hid_ll_driver *driver) 803 { 804 return hdev->ll_driver == driver; 805 } 806 807 #define PM_HINT_FULLON 1<<5 808 #define PM_HINT_NORMAL 1<<1 809 810 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ 811 /* We ignore a few input applications that are not widely used */ 812 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) 813 814 /* HID core API */ 815 816 extern int hid_debug; 817 818 extern bool hid_ignore(struct hid_device *); 819 extern int hid_add_device(struct hid_device *); 820 extern void hid_destroy_device(struct hid_device *); 821 822 extern struct bus_type hid_bus_type; 823 824 extern int __must_check __hid_register_driver(struct hid_driver *, 825 struct module *, const char *mod_name); 826 827 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 828 #define hid_register_driver(driver) \ 829 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 830 831 extern void hid_unregister_driver(struct hid_driver *); 832 833 /** 834 * module_hid_driver() - Helper macro for registering a HID driver 835 * @__hid_driver: hid_driver struct 836 * 837 * Helper macro for HID drivers which do not do anything special in module 838 * init/exit. This eliminates a lot of boilerplate. Each module may only 839 * use this macro once, and calling it replaces module_init() and module_exit() 840 */ 841 #define module_hid_driver(__hid_driver) \ 842 module_driver(__hid_driver, hid_register_driver, \ 843 hid_unregister_driver) 844 845 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); 846 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); 847 extern int hidinput_connect(struct hid_device *hid, unsigned int force); 848 extern void hidinput_disconnect(struct hid_device *); 849 850 int hid_set_field(struct hid_field *, unsigned, __s32); 851 int hid_input_report(struct hid_device *, int type, u8 *, u32, int); 852 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); 853 struct hid_field *hidinput_get_led_field(struct hid_device *hid); 854 unsigned int hidinput_count_leds(struct hid_device *hid); 855 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); 856 void hid_output_report(struct hid_report *report, __u8 *data); 857 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype); 858 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); 859 struct hid_device *hid_allocate_device(void); 860 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); 861 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); 862 struct hid_report *hid_validate_values(struct hid_device *hid, 863 unsigned int type, unsigned int id, 864 unsigned int field_index, 865 unsigned int report_counts); 866 int hid_open_report(struct hid_device *device); 867 int hid_check_keys_pressed(struct hid_device *hid); 868 int hid_connect(struct hid_device *hid, unsigned int connect_mask); 869 void hid_disconnect(struct hid_device *hid); 870 bool hid_match_one_id(const struct hid_device *hdev, 871 const struct hid_device_id *id); 872 const struct hid_device_id *hid_match_id(const struct hid_device *hdev, 873 const struct hid_device_id *id); 874 const struct hid_device_id *hid_match_device(struct hid_device *hdev, 875 struct hid_driver *hdrv); 876 s32 hid_snto32(__u32 value, unsigned n); 877 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report, 878 unsigned offset, unsigned n); 879 880 /** 881 * hid_device_io_start - enable HID input during probe, remove 882 * 883 * @hid - the device 884 * 885 * This should only be called during probe or remove and only be 886 * called by the thread calling probe or remove. It will allow 887 * incoming packets to be delivered to the driver. 888 */ 889 static inline void hid_device_io_start(struct hid_device *hid) { 890 if (hid->io_started) { 891 dev_warn(&hid->dev, "io already started\n"); 892 return; 893 } 894 hid->io_started = true; 895 up(&hid->driver_input_lock); 896 } 897 898 /** 899 * hid_device_io_stop - disable HID input during probe, remove 900 * 901 * @hid - the device 902 * 903 * Should only be called after hid_device_io_start. It will prevent 904 * incoming packets from going to the driver for the duration of 905 * probe, remove. If called during probe, packets will still go to the 906 * driver after probe is complete. This function should only be called 907 * by the thread calling probe or remove. 908 */ 909 static inline void hid_device_io_stop(struct hid_device *hid) { 910 if (!hid->io_started) { 911 dev_warn(&hid->dev, "io already stopped\n"); 912 return; 913 } 914 hid->io_started = false; 915 down(&hid->driver_input_lock); 916 } 917 918 /** 919 * hid_map_usage - map usage input bits 920 * 921 * @hidinput: hidinput which we are interested in 922 * @usage: usage to fill in 923 * @bit: pointer to input->{}bit (out parameter) 924 * @max: maximal valid usage->code to consider later (out parameter) 925 * @type: input event type (EV_KEY, EV_REL, ...) 926 * @c: code which corresponds to this usage and type 927 */ 928 static inline void hid_map_usage(struct hid_input *hidinput, 929 struct hid_usage *usage, unsigned long **bit, int *max, 930 __u8 type, __u16 c) 931 { 932 struct input_dev *input = hidinput->input; 933 934 usage->type = type; 935 usage->code = c; 936 937 switch (type) { 938 case EV_ABS: 939 *bit = input->absbit; 940 *max = ABS_MAX; 941 break; 942 case EV_REL: 943 *bit = input->relbit; 944 *max = REL_MAX; 945 break; 946 case EV_KEY: 947 *bit = input->keybit; 948 *max = KEY_MAX; 949 break; 950 case EV_LED: 951 *bit = input->ledbit; 952 *max = LED_MAX; 953 break; 954 } 955 } 956 957 /** 958 * hid_map_usage_clear - map usage input bits and clear the input bit 959 * 960 * The same as hid_map_usage, except the @c bit is also cleared in supported 961 * bits (@bit). 962 */ 963 static inline void hid_map_usage_clear(struct hid_input *hidinput, 964 struct hid_usage *usage, unsigned long **bit, int *max, 965 __u8 type, __u16 c) 966 { 967 hid_map_usage(hidinput, usage, bit, max, type, c); 968 clear_bit(c, *bit); 969 } 970 971 /** 972 * hid_parse - parse HW reports 973 * 974 * @hdev: hid device 975 * 976 * Call this from probe after you set up the device (if needed). Your 977 * report_fixup will be called (if non-NULL) after reading raw report from 978 * device before passing it to hid layer for real parsing. 979 */ 980 static inline int __must_check hid_parse(struct hid_device *hdev) 981 { 982 return hid_open_report(hdev); 983 } 984 985 int __must_check hid_hw_start(struct hid_device *hdev, 986 unsigned int connect_mask); 987 void hid_hw_stop(struct hid_device *hdev); 988 int __must_check hid_hw_open(struct hid_device *hdev); 989 void hid_hw_close(struct hid_device *hdev); 990 991 /** 992 * hid_hw_power - requests underlying HW to go into given power mode 993 * 994 * @hdev: hid device 995 * @level: requested power level (one of %PM_HINT_* defines) 996 * 997 * This function requests underlying hardware to enter requested power 998 * mode. 999 */ 1000 1001 static inline int hid_hw_power(struct hid_device *hdev, int level) 1002 { 1003 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; 1004 } 1005 1006 1007 /** 1008 * hid_hw_request - send report request to device 1009 * 1010 * @hdev: hid device 1011 * @report: report to send 1012 * @reqtype: hid request type 1013 */ 1014 static inline void hid_hw_request(struct hid_device *hdev, 1015 struct hid_report *report, int reqtype) 1016 { 1017 if (hdev->ll_driver->request) 1018 return hdev->ll_driver->request(hdev, report, reqtype); 1019 1020 __hid_request(hdev, report, reqtype); 1021 } 1022 1023 /** 1024 * hid_hw_raw_request - send report request to device 1025 * 1026 * @hdev: hid device 1027 * @reportnum: report ID 1028 * @buf: in/out data to transfer 1029 * @len: length of buf 1030 * @rtype: HID report type 1031 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT 1032 * 1033 * @return: count of data transfered, negative if error 1034 * 1035 * Same behavior as hid_hw_request, but with raw buffers instead. 1036 */ 1037 static inline int hid_hw_raw_request(struct hid_device *hdev, 1038 unsigned char reportnum, __u8 *buf, 1039 size_t len, unsigned char rtype, int reqtype) 1040 { 1041 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) 1042 return -EINVAL; 1043 1044 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len, 1045 rtype, reqtype); 1046 } 1047 1048 /** 1049 * hid_hw_output_report - send output report to device 1050 * 1051 * @hdev: hid device 1052 * @buf: raw data to transfer 1053 * @len: length of buf 1054 * 1055 * @return: count of data transfered, negative if error 1056 */ 1057 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, 1058 size_t len) 1059 { 1060 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) 1061 return -EINVAL; 1062 1063 if (hdev->ll_driver->output_report) 1064 return hdev->ll_driver->output_report(hdev, buf, len); 1065 1066 return -ENOSYS; 1067 } 1068 1069 /** 1070 * hid_hw_idle - send idle request to device 1071 * 1072 * @hdev: hid device 1073 * @report: report to control 1074 * @idle: idle state 1075 * @reqtype: hid request type 1076 */ 1077 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, 1078 int reqtype) 1079 { 1080 if (hdev->ll_driver->idle) 1081 return hdev->ll_driver->idle(hdev, report, idle, reqtype); 1082 1083 return 0; 1084 } 1085 1086 /** 1087 * hid_hw_wait - wait for buffered io to complete 1088 * 1089 * @hdev: hid device 1090 */ 1091 static inline void hid_hw_wait(struct hid_device *hdev) 1092 { 1093 if (hdev->ll_driver->wait) 1094 hdev->ll_driver->wait(hdev); 1095 } 1096 1097 /** 1098 * hid_report_len - calculate the report length 1099 * 1100 * @report: the report we want to know the length 1101 */ 1102 static inline u32 hid_report_len(struct hid_report *report) 1103 { 1104 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */ 1105 return ((report->size - 1) >> 3) + 1 + (report->id > 0); 1106 } 1107 1108 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size, 1109 int interrupt); 1110 1111 /* HID quirks API */ 1112 unsigned long hid_lookup_quirk(const struct hid_device *hdev); 1113 int hid_quirks_init(char **quirks_param, __u16 bus, int count); 1114 void hid_quirks_exit(__u16 bus); 1115 1116 #ifdef CONFIG_HID_PID 1117 int hid_pidff_init(struct hid_device *hid); 1118 #else 1119 #define hid_pidff_init NULL 1120 #endif 1121 1122 #define dbg_hid(format, arg...) \ 1123 do { \ 1124 if (hid_debug) \ 1125 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ 1126 } while (0) 1127 1128 #define hid_printk(level, hid, fmt, arg...) \ 1129 dev_printk(level, &(hid)->dev, fmt, ##arg) 1130 #define hid_emerg(hid, fmt, arg...) \ 1131 dev_emerg(&(hid)->dev, fmt, ##arg) 1132 #define hid_crit(hid, fmt, arg...) \ 1133 dev_crit(&(hid)->dev, fmt, ##arg) 1134 #define hid_alert(hid, fmt, arg...) \ 1135 dev_alert(&(hid)->dev, fmt, ##arg) 1136 #define hid_err(hid, fmt, arg...) \ 1137 dev_err(&(hid)->dev, fmt, ##arg) 1138 #define hid_notice(hid, fmt, arg...) \ 1139 dev_notice(&(hid)->dev, fmt, ##arg) 1140 #define hid_warn(hid, fmt, arg...) \ 1141 dev_warn(&(hid)->dev, fmt, ##arg) 1142 #define hid_info(hid, fmt, arg...) \ 1143 dev_info(&(hid)->dev, fmt, ##arg) 1144 #define hid_dbg(hid, fmt, arg...) \ 1145 dev_dbg(&(hid)->dev, fmt, ##arg) 1146 1147 #endif 1148