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