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