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