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