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 * This is the global environment of the parser. This information is 367 * persistent for main-items. The global environment can be saved and 368 * restored with PUSH/POP statements. 369 */ 370 371 struct hid_global { 372 unsigned usage_page; 373 __s32 logical_minimum; 374 __s32 logical_maximum; 375 __s32 physical_minimum; 376 __s32 physical_maximum; 377 __s32 unit_exponent; 378 unsigned unit; 379 unsigned report_id; 380 unsigned report_size; 381 unsigned report_count; 382 }; 383 384 /* 385 * This is the local environment. It is persistent up the next main-item. 386 */ 387 388 #define HID_MAX_USAGES 12288 389 #define HID_DEFAULT_NUM_COLLECTIONS 16 390 391 struct hid_local { 392 unsigned usage[HID_MAX_USAGES]; /* usage array */ 393 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ 394 unsigned usage_index; 395 unsigned usage_minimum; 396 unsigned delimiter_depth; 397 unsigned delimiter_branch; 398 }; 399 400 /* 401 * This is the collection stack. We climb up the stack to determine 402 * application and function of each field. 403 */ 404 405 struct hid_collection { 406 unsigned type; 407 unsigned usage; 408 unsigned level; 409 }; 410 411 struct hid_usage { 412 unsigned hid; /* hid usage code */ 413 unsigned collection_index; /* index into collection array */ 414 unsigned usage_index; /* index into usage array */ 415 /* hidinput data */ 416 __u16 code; /* input driver code */ 417 __u8 type; /* input driver type */ 418 __s8 hat_min; /* hat switch fun */ 419 __s8 hat_max; /* ditto */ 420 __s8 hat_dir; /* ditto */ 421 }; 422 423 struct hid_input; 424 425 struct hid_field { 426 unsigned physical; /* physical usage for this field */ 427 unsigned logical; /* logical usage for this field */ 428 unsigned application; /* application usage for this field */ 429 struct hid_usage *usage; /* usage table for this function */ 430 unsigned maxusage; /* maximum usage index */ 431 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ 432 unsigned report_offset; /* bit offset in the report */ 433 unsigned report_size; /* size of this field in the report */ 434 unsigned report_count; /* number of this field in the report */ 435 unsigned report_type; /* (input,output,feature) */ 436 __s32 *value; /* last known value(s) */ 437 __s32 logical_minimum; 438 __s32 logical_maximum; 439 __s32 physical_minimum; 440 __s32 physical_maximum; 441 __s32 unit_exponent; 442 unsigned unit; 443 struct hid_report *report; /* associated report */ 444 unsigned index; /* index into report->field[] */ 445 /* hidinput data */ 446 struct hid_input *hidinput; /* associated input structure */ 447 __u16 dpad; /* dpad input code */ 448 }; 449 450 #define HID_MAX_FIELDS 256 451 452 struct hid_report { 453 struct list_head list; 454 unsigned id; /* id of this report */ 455 unsigned type; /* report type */ 456 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ 457 unsigned maxfield; /* maximum valid field index */ 458 unsigned size; /* size of the report (bits) */ 459 struct hid_device *device; /* associated device */ 460 }; 461 462 #define HID_MAX_IDS 256 463 464 struct hid_report_enum { 465 unsigned numbered; 466 struct list_head report_list; 467 struct hid_report *report_id_hash[HID_MAX_IDS]; 468 }; 469 470 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ 471 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ 472 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ 473 #define HID_OUTPUT_FIFO_SIZE 64 474 475 struct hid_control_fifo { 476 unsigned char dir; 477 struct hid_report *report; 478 char *raw_report; 479 }; 480 481 struct hid_output_fifo { 482 struct hid_report *report; 483 char *raw_report; 484 }; 485 486 #define HID_CLAIMED_INPUT 1 487 #define HID_CLAIMED_HIDDEV 2 488 #define HID_CLAIMED_HIDRAW 4 489 #define HID_CLAIMED_DRIVER 8 490 491 #define HID_STAT_ADDED 1 492 #define HID_STAT_PARSED 2 493 494 struct hid_input { 495 struct list_head list; 496 struct hid_report *report; 497 struct input_dev *input; 498 bool registered; 499 }; 500 501 enum hid_type { 502 HID_TYPE_OTHER = 0, 503 HID_TYPE_USBMOUSE, 504 HID_TYPE_USBNONE 505 }; 506 507 struct hid_driver; 508 struct hid_ll_driver; 509 510 struct hid_device { /* device report descriptor */ 511 __u8 *dev_rdesc; 512 unsigned dev_rsize; 513 __u8 *rdesc; 514 unsigned rsize; 515 struct hid_collection *collection; /* List of HID collections */ 516 unsigned collection_size; /* Number of allocated hid_collections */ 517 unsigned maxcollection; /* Number of parsed collections */ 518 unsigned maxapplication; /* Number of applications */ 519 __u16 bus; /* BUS ID */ 520 __u16 group; /* Report group */ 521 __u32 vendor; /* Vendor ID */ 522 __u32 product; /* Product ID */ 523 __u32 version; /* HID version */ 524 enum hid_type type; /* device type (mouse, kbd, ...) */ 525 unsigned country; /* HID country */ 526 struct hid_report_enum report_enum[HID_REPORT_TYPES]; 527 struct work_struct led_work; /* delayed LED worker */ 528 529 struct semaphore driver_lock; /* protects the current driver, except during input */ 530 struct semaphore driver_input_lock; /* protects the current driver */ 531 struct device dev; /* device */ 532 struct hid_driver *driver; 533 534 struct hid_ll_driver *ll_driver; 535 struct mutex ll_open_lock; 536 unsigned int ll_open_count; 537 538 #ifdef CONFIG_HID_BATTERY_STRENGTH 539 /* 540 * Power supply information for HID devices which report 541 * battery strength. power_supply was successfully registered if 542 * battery is non-NULL. 543 */ 544 struct power_supply *battery; 545 __s32 battery_min; 546 __s32 battery_max; 547 __s32 battery_report_type; 548 __s32 battery_report_id; 549 #endif 550 551 unsigned int status; /* see STAT flags above */ 552 unsigned claimed; /* Claimed by hidinput, hiddev? */ 553 unsigned quirks; /* Various quirks the device can pull on us */ 554 bool io_started; /* Protected by driver_lock. If IO has started */ 555 556 struct list_head inputs; /* The list of inputs */ 557 void *hiddev; /* The hiddev structure */ 558 void *hidraw; 559 560 char name[128]; /* Device name */ 561 char phys[64]; /* Device physical location */ 562 char uniq[64]; /* Device unique identifier (serial #) */ 563 564 void *driver_data; 565 566 /* temporary hid_ff handling (until moved to the drivers) */ 567 int (*ff_init)(struct hid_device *); 568 569 /* hiddev event handler */ 570 int (*hiddev_connect)(struct hid_device *, unsigned int); 571 void (*hiddev_disconnect)(struct hid_device *); 572 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, 573 struct hid_usage *, __s32); 574 void (*hiddev_report_event) (struct hid_device *, struct hid_report *); 575 576 /* debugging support via debugfs */ 577 unsigned short debug; 578 struct dentry *debug_dir; 579 struct dentry *debug_rdesc; 580 struct dentry *debug_events; 581 struct list_head debug_list; 582 spinlock_t debug_list_lock; 583 wait_queue_head_t debug_wait; 584 }; 585 586 #define to_hid_device(pdev) \ 587 container_of(pdev, struct hid_device, dev) 588 589 static inline void *hid_get_drvdata(struct hid_device *hdev) 590 { 591 return dev_get_drvdata(&hdev->dev); 592 } 593 594 static inline void hid_set_drvdata(struct hid_device *hdev, void *data) 595 { 596 dev_set_drvdata(&hdev->dev, data); 597 } 598 599 #define HID_GLOBAL_STACK_SIZE 4 600 #define HID_COLLECTION_STACK_SIZE 4 601 602 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0) 603 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1) 604 #define HID_SCAN_FLAG_GD_POINTER BIT(2) 605 606 struct hid_parser { 607 struct hid_global global; 608 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; 609 unsigned global_stack_ptr; 610 struct hid_local local; 611 unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; 612 unsigned collection_stack_ptr; 613 struct hid_device *device; 614 unsigned scan_flags; 615 }; 616 617 struct hid_class_descriptor { 618 __u8 bDescriptorType; 619 __le16 wDescriptorLength; 620 } __attribute__ ((packed)); 621 622 struct hid_descriptor { 623 __u8 bLength; 624 __u8 bDescriptorType; 625 __le16 bcdHID; 626 __u8 bCountryCode; 627 __u8 bNumDescriptors; 628 629 struct hid_class_descriptor desc[1]; 630 } __attribute__ ((packed)); 631 632 #define HID_DEVICE(b, g, ven, prod) \ 633 .bus = (b), .group = (g), .vendor = (ven), .product = (prod) 634 #define HID_USB_DEVICE(ven, prod) \ 635 .bus = BUS_USB, .vendor = (ven), .product = (prod) 636 #define HID_BLUETOOTH_DEVICE(ven, prod) \ 637 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) 638 #define HID_I2C_DEVICE(ven, prod) \ 639 .bus = BUS_I2C, .vendor = (ven), .product = (prod) 640 641 #define HID_REPORT_ID(rep) \ 642 .report_type = (rep) 643 #define HID_USAGE_ID(uhid, utype, ucode) \ 644 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) 645 /* we don't want to catch types and codes equal to 0 */ 646 #define HID_TERMINATOR (HID_ANY_ID - 1) 647 648 struct hid_report_id { 649 __u32 report_type; 650 }; 651 struct hid_usage_id { 652 __u32 usage_hid; 653 __u32 usage_type; 654 __u32 usage_code; 655 }; 656 657 /** 658 * struct hid_driver 659 * @name: driver name (e.g. "Footech_bar-wheel") 660 * @id_table: which devices is this driver for (must be non-NULL for probe 661 * to be called) 662 * @dyn_list: list of dynamically added device ids 663 * @dyn_lock: lock protecting @dyn_list 664 * @probe: new device inserted 665 * @remove: device removed (NULL if not a hot-plug capable driver) 666 * @report_table: on which reports to call raw_event (NULL means all) 667 * @raw_event: if report in report_table, this hook is called (NULL means nop) 668 * @usage_table: on which events to call event (NULL means all) 669 * @event: if usage in usage_table, this hook is called (NULL means nop) 670 * @report: this hook is called after parsing a report (NULL means nop) 671 * @report_fixup: called before report descriptor parsing (NULL means nop) 672 * @input_mapping: invoked on input registering before mapping an usage 673 * @input_mapped: invoked on input registering after mapping an usage 674 * @input_configured: invoked just before the device is registered 675 * @feature_mapping: invoked on feature registering 676 * @suspend: invoked on suspend (NULL means nop) 677 * @resume: invoked on resume if device was not reset (NULL means nop) 678 * @reset_resume: invoked on resume if device was reset (NULL means nop) 679 * 680 * probe should return -errno on error, or 0 on success. During probe, 681 * input will not be passed to raw_event unless hid_device_io_start is 682 * called. 683 * 684 * raw_event and event should return 0 on no action performed, 1 when no 685 * further processing should be done and negative on error 686 * 687 * input_mapping shall return a negative value to completely ignore this usage 688 * (e.g. doubled or invalid usage), zero to continue with parsing of this 689 * usage by generic code (no special handling needed) or positive to skip 690 * generic parsing (needed special handling which was done in the hook already) 691 * input_mapped shall return negative to inform the layer that this usage 692 * should not be considered for further processing or zero to notify that 693 * no processing was performed and should be done in a generic manner 694 * Both these functions may be NULL which means the same behavior as returning 695 * zero from them. 696 */ 697 struct hid_driver { 698 char *name; 699 const struct hid_device_id *id_table; 700 701 struct list_head dyn_list; 702 spinlock_t dyn_lock; 703 704 int (*probe)(struct hid_device *dev, const struct hid_device_id *id); 705 void (*remove)(struct hid_device *dev); 706 707 const struct hid_report_id *report_table; 708 int (*raw_event)(struct hid_device *hdev, struct hid_report *report, 709 u8 *data, int size); 710 const struct hid_usage_id *usage_table; 711 int (*event)(struct hid_device *hdev, struct hid_field *field, 712 struct hid_usage *usage, __s32 value); 713 void (*report)(struct hid_device *hdev, struct hid_report *report); 714 715 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, 716 unsigned int *size); 717 718 int (*input_mapping)(struct hid_device *hdev, 719 struct hid_input *hidinput, struct hid_field *field, 720 struct hid_usage *usage, unsigned long **bit, int *max); 721 int (*input_mapped)(struct hid_device *hdev, 722 struct hid_input *hidinput, struct hid_field *field, 723 struct hid_usage *usage, unsigned long **bit, int *max); 724 int (*input_configured)(struct hid_device *hdev, 725 struct hid_input *hidinput); 726 void (*feature_mapping)(struct hid_device *hdev, 727 struct hid_field *field, 728 struct hid_usage *usage); 729 #ifdef CONFIG_PM 730 int (*suspend)(struct hid_device *hdev, pm_message_t message); 731 int (*resume)(struct hid_device *hdev); 732 int (*reset_resume)(struct hid_device *hdev); 733 #endif 734 /* private: */ 735 struct device_driver driver; 736 }; 737 738 #define to_hid_driver(pdrv) \ 739 container_of(pdrv, struct hid_driver, driver) 740 741 /** 742 * hid_ll_driver - low level driver callbacks 743 * @start: called on probe to start the device 744 * @stop: called on remove 745 * @open: called by input layer on open 746 * @close: called by input layer on close 747 * @parse: this method is called only once to parse the device data, 748 * shouldn't allocate anything to not leak memory 749 * @request: send report request to device (e.g. feature report) 750 * @wait: wait for buffered io to complete (send/recv reports) 751 * @raw_request: send raw report request to device (e.g. feature report) 752 * @output_report: send output report to device 753 * @idle: send idle request to device 754 */ 755 struct hid_ll_driver { 756 int (*start)(struct hid_device *hdev); 757 void (*stop)(struct hid_device *hdev); 758 759 int (*open)(struct hid_device *hdev); 760 void (*close)(struct hid_device *hdev); 761 762 int (*power)(struct hid_device *hdev, int level); 763 764 int (*parse)(struct hid_device *hdev); 765 766 void (*request)(struct hid_device *hdev, 767 struct hid_report *report, int reqtype); 768 769 int (*wait)(struct hid_device *hdev); 770 771 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, 772 __u8 *buf, size_t len, unsigned char rtype, 773 int reqtype); 774 775 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len); 776 777 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); 778 }; 779 780 #define PM_HINT_FULLON 1<<5 781 #define PM_HINT_NORMAL 1<<1 782 783 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ 784 /* We ignore a few input applications that are not widely used */ 785 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) 786 787 /* HID core API */ 788 789 extern int hid_debug; 790 791 extern bool hid_ignore(struct hid_device *); 792 extern int hid_add_device(struct hid_device *); 793 extern void hid_destroy_device(struct hid_device *); 794 795 extern int __must_check __hid_register_driver(struct hid_driver *, 796 struct module *, const char *mod_name); 797 798 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 799 #define hid_register_driver(driver) \ 800 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 801 802 extern void hid_unregister_driver(struct hid_driver *); 803 804 /** 805 * module_hid_driver() - Helper macro for registering a HID driver 806 * @__hid_driver: hid_driver struct 807 * 808 * Helper macro for HID drivers which do not do anything special in module 809 * init/exit. This eliminates a lot of boilerplate. Each module may only 810 * use this macro once, and calling it replaces module_init() and module_exit() 811 */ 812 #define module_hid_driver(__hid_driver) \ 813 module_driver(__hid_driver, hid_register_driver, \ 814 hid_unregister_driver) 815 816 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); 817 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); 818 extern int hidinput_connect(struct hid_device *hid, unsigned int force); 819 extern void hidinput_disconnect(struct hid_device *); 820 821 int hid_set_field(struct hid_field *, unsigned, __s32); 822 int hid_input_report(struct hid_device *, int type, u8 *, int, int); 823 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); 824 struct hid_field *hidinput_get_led_field(struct hid_device *hid); 825 unsigned int hidinput_count_leds(struct hid_device *hid); 826 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); 827 void hid_output_report(struct hid_report *report, __u8 *data); 828 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype); 829 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); 830 struct hid_device *hid_allocate_device(void); 831 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); 832 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); 833 struct hid_report *hid_validate_values(struct hid_device *hid, 834 unsigned int type, unsigned int id, 835 unsigned int field_index, 836 unsigned int report_counts); 837 int hid_open_report(struct hid_device *device); 838 int hid_check_keys_pressed(struct hid_device *hid); 839 int hid_connect(struct hid_device *hid, unsigned int connect_mask); 840 void hid_disconnect(struct hid_device *hid); 841 const struct hid_device_id *hid_match_id(struct hid_device *hdev, 842 const struct hid_device_id *id); 843 s32 hid_snto32(__u32 value, unsigned n); 844 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report, 845 unsigned offset, unsigned n); 846 847 /** 848 * hid_device_io_start - enable HID input during probe, remove 849 * 850 * @hid - the device 851 * 852 * This should only be called during probe or remove and only be 853 * called by the thread calling probe or remove. It will allow 854 * incoming packets to be delivered to the driver. 855 */ 856 static inline void hid_device_io_start(struct hid_device *hid) { 857 if (hid->io_started) { 858 dev_warn(&hid->dev, "io already started\n"); 859 return; 860 } 861 hid->io_started = true; 862 up(&hid->driver_input_lock); 863 } 864 865 /** 866 * hid_device_io_stop - disable HID input during probe, remove 867 * 868 * @hid - the device 869 * 870 * Should only be called after hid_device_io_start. It will prevent 871 * incoming packets from going to the driver for the duration of 872 * probe, remove. If called during probe, packets will still go to the 873 * driver after probe is complete. This function should only be called 874 * by the thread calling probe or remove. 875 */ 876 static inline void hid_device_io_stop(struct hid_device *hid) { 877 if (!hid->io_started) { 878 dev_warn(&hid->dev, "io already stopped\n"); 879 return; 880 } 881 hid->io_started = false; 882 down(&hid->driver_input_lock); 883 } 884 885 /** 886 * hid_map_usage - map usage input bits 887 * 888 * @hidinput: hidinput which we are interested in 889 * @usage: usage to fill in 890 * @bit: pointer to input->{}bit (out parameter) 891 * @max: maximal valid usage->code to consider later (out parameter) 892 * @type: input event type (EV_KEY, EV_REL, ...) 893 * @c: code which corresponds to this usage and type 894 */ 895 static inline void hid_map_usage(struct hid_input *hidinput, 896 struct hid_usage *usage, unsigned long **bit, int *max, 897 __u8 type, __u16 c) 898 { 899 struct input_dev *input = hidinput->input; 900 901 usage->type = type; 902 usage->code = c; 903 904 switch (type) { 905 case EV_ABS: 906 *bit = input->absbit; 907 *max = ABS_MAX; 908 break; 909 case EV_REL: 910 *bit = input->relbit; 911 *max = REL_MAX; 912 break; 913 case EV_KEY: 914 *bit = input->keybit; 915 *max = KEY_MAX; 916 break; 917 case EV_LED: 918 *bit = input->ledbit; 919 *max = LED_MAX; 920 break; 921 } 922 } 923 924 /** 925 * hid_map_usage_clear - map usage input bits and clear the input bit 926 * 927 * The same as hid_map_usage, except the @c bit is also cleared in supported 928 * bits (@bit). 929 */ 930 static inline void hid_map_usage_clear(struct hid_input *hidinput, 931 struct hid_usage *usage, unsigned long **bit, int *max, 932 __u8 type, __u16 c) 933 { 934 hid_map_usage(hidinput, usage, bit, max, type, c); 935 clear_bit(c, *bit); 936 } 937 938 /** 939 * hid_parse - parse HW reports 940 * 941 * @hdev: hid device 942 * 943 * Call this from probe after you set up the device (if needed). Your 944 * report_fixup will be called (if non-NULL) after reading raw report from 945 * device before passing it to hid layer for real parsing. 946 */ 947 static inline int __must_check hid_parse(struct hid_device *hdev) 948 { 949 return hid_open_report(hdev); 950 } 951 952 int __must_check hid_hw_start(struct hid_device *hdev, 953 unsigned int connect_mask); 954 void hid_hw_stop(struct hid_device *hdev); 955 int __must_check hid_hw_open(struct hid_device *hdev); 956 void hid_hw_close(struct hid_device *hdev); 957 958 /** 959 * hid_hw_power - requests underlying HW to go into given power mode 960 * 961 * @hdev: hid device 962 * @level: requested power level (one of %PM_HINT_* defines) 963 * 964 * This function requests underlying hardware to enter requested power 965 * mode. 966 */ 967 968 static inline int hid_hw_power(struct hid_device *hdev, int level) 969 { 970 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; 971 } 972 973 974 /** 975 * hid_hw_request - send report request to device 976 * 977 * @hdev: hid device 978 * @report: report to send 979 * @reqtype: hid request type 980 */ 981 static inline void hid_hw_request(struct hid_device *hdev, 982 struct hid_report *report, int reqtype) 983 { 984 if (hdev->ll_driver->request) 985 return hdev->ll_driver->request(hdev, report, reqtype); 986 987 __hid_request(hdev, report, reqtype); 988 } 989 990 /** 991 * hid_hw_raw_request - send report request to device 992 * 993 * @hdev: hid device 994 * @reportnum: report ID 995 * @buf: in/out data to transfer 996 * @len: length of buf 997 * @rtype: HID report type 998 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT 999 * 1000 * @return: count of data transfered, negative if error 1001 * 1002 * Same behavior as hid_hw_request, but with raw buffers instead. 1003 */ 1004 static inline int hid_hw_raw_request(struct hid_device *hdev, 1005 unsigned char reportnum, __u8 *buf, 1006 size_t len, unsigned char rtype, int reqtype) 1007 { 1008 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) 1009 return -EINVAL; 1010 1011 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len, 1012 rtype, reqtype); 1013 } 1014 1015 /** 1016 * hid_hw_output_report - send output report to device 1017 * 1018 * @hdev: hid device 1019 * @buf: raw data to transfer 1020 * @len: length of buf 1021 * 1022 * @return: count of data transfered, negative if error 1023 */ 1024 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, 1025 size_t len) 1026 { 1027 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) 1028 return -EINVAL; 1029 1030 if (hdev->ll_driver->output_report) 1031 return hdev->ll_driver->output_report(hdev, buf, len); 1032 1033 return -ENOSYS; 1034 } 1035 1036 /** 1037 * hid_hw_idle - send idle request to device 1038 * 1039 * @hdev: hid device 1040 * @report: report to control 1041 * @idle: idle state 1042 * @reqtype: hid request type 1043 */ 1044 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, 1045 int reqtype) 1046 { 1047 if (hdev->ll_driver->idle) 1048 return hdev->ll_driver->idle(hdev, report, idle, reqtype); 1049 1050 return 0; 1051 } 1052 1053 /** 1054 * hid_hw_wait - wait for buffered io to complete 1055 * 1056 * @hdev: hid device 1057 */ 1058 static inline void hid_hw_wait(struct hid_device *hdev) 1059 { 1060 if (hdev->ll_driver->wait) 1061 hdev->ll_driver->wait(hdev); 1062 } 1063 1064 /** 1065 * hid_report_len - calculate the report length 1066 * 1067 * @report: the report we want to know the length 1068 */ 1069 static inline int hid_report_len(struct hid_report *report) 1070 { 1071 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */ 1072 return ((report->size - 1) >> 3) + 1 + (report->id > 0); 1073 } 1074 1075 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, 1076 int interrupt); 1077 1078 /* HID quirks API */ 1079 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); 1080 int usbhid_quirks_init(char **quirks_param); 1081 void usbhid_quirks_exit(void); 1082 1083 #ifdef CONFIG_HID_PID 1084 int hid_pidff_init(struct hid_device *hid); 1085 #else 1086 #define hid_pidff_init NULL 1087 #endif 1088 1089 #define dbg_hid(format, arg...) \ 1090 do { \ 1091 if (hid_debug) \ 1092 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ 1093 } while (0) 1094 1095 #define hid_printk(level, hid, fmt, arg...) \ 1096 dev_printk(level, &(hid)->dev, fmt, ##arg) 1097 #define hid_emerg(hid, fmt, arg...) \ 1098 dev_emerg(&(hid)->dev, fmt, ##arg) 1099 #define hid_crit(hid, fmt, arg...) \ 1100 dev_crit(&(hid)->dev, fmt, ##arg) 1101 #define hid_alert(hid, fmt, arg...) \ 1102 dev_alert(&(hid)->dev, fmt, ##arg) 1103 #define hid_err(hid, fmt, arg...) \ 1104 dev_err(&(hid)->dev, fmt, ##arg) 1105 #define hid_notice(hid, fmt, arg...) \ 1106 dev_notice(&(hid)->dev, fmt, ##arg) 1107 #define hid_warn(hid, fmt, arg...) \ 1108 dev_warn(&(hid)->dev, fmt, ##arg) 1109 #define hid_info(hid, fmt, arg...) \ 1110 dev_info(&(hid)->dev, fmt, ##arg) 1111 #define hid_dbg(hid, fmt, arg...) \ 1112 dev_dbg(&(hid)->dev, fmt, ##arg) 1113 1114 #endif 1115