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 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 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_IGNORE_MOUSE: 361 * | @HID_QUIRK_SKIP_OUTPUT_REPORTS: 362 * | @HID_QUIRK_SKIP_OUTPUT_REPORT_ID: 363 * | @HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP: 364 * | @HID_QUIRK_HAVE_SPECIAL_DRIVER: 365 * | @HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE: 366 * | @HID_QUIRK_IGNORE_SPECIAL_DRIVER 367 * | @HID_QUIRK_POWER_ON_AFTER_BACKLIGHT 368 * | @HID_QUIRK_FULLSPEED_INTERVAL: 369 * | @HID_QUIRK_NO_INIT_REPORTS: 370 * | @HID_QUIRK_NO_IGNORE: 371 * | @HID_QUIRK_NO_INPUT_SYNC: 372 */ 373 /* BIT(0) reserved for backward compatibility, was HID_QUIRK_INVERT */ 374 #define HID_QUIRK_NOTOUCH BIT(1) 375 #define HID_QUIRK_IGNORE BIT(2) 376 #define HID_QUIRK_NOGET BIT(3) 377 #define HID_QUIRK_HIDDEV_FORCE BIT(4) 378 #define HID_QUIRK_BADPAD BIT(5) 379 #define HID_QUIRK_MULTI_INPUT BIT(6) 380 #define HID_QUIRK_HIDINPUT_FORCE BIT(7) 381 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */ 382 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */ 383 #define HID_QUIRK_ALWAYS_POLL BIT(10) 384 #define HID_QUIRK_INPUT_PER_APP BIT(11) 385 #define HID_QUIRK_X_INVERT BIT(12) 386 #define HID_QUIRK_Y_INVERT BIT(13) 387 #define HID_QUIRK_IGNORE_MOUSE BIT(14) 388 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16) 389 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17) 390 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18) 391 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19) 392 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20) 393 #define HID_QUIRK_NOINVERT BIT(21) 394 #define HID_QUIRK_IGNORE_SPECIAL_DRIVER BIT(22) 395 #define HID_QUIRK_POWER_ON_AFTER_BACKLIGHT BIT(23) 396 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28) 397 #define HID_QUIRK_NO_INIT_REPORTS BIT(29) 398 #define HID_QUIRK_NO_IGNORE BIT(30) 399 #define HID_QUIRK_NO_INPUT_SYNC BIT(31) 400 401 /* 402 * HID device groups 403 * 404 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h 405 * and has a value of 0x0000 406 */ 407 #define HID_GROUP_GENERIC 0x0001 408 #define HID_GROUP_MULTITOUCH 0x0002 409 #define HID_GROUP_SENSOR_HUB 0x0003 410 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 411 412 /* 413 * Vendor specific HID device groups 414 */ 415 #define HID_GROUP_RMI 0x0100 416 #define HID_GROUP_WACOM 0x0101 417 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102 418 #define HID_GROUP_STEAM 0x0103 419 #define HID_GROUP_LOGITECH_27MHZ_DEVICE 0x0104 420 #define HID_GROUP_VIVALDI 0x0105 421 422 /* 423 * HID protocol status 424 */ 425 #define HID_REPORT_PROTOCOL 1 426 #define HID_BOOT_PROTOCOL 0 427 428 /* 429 * This is the global environment of the parser. This information is 430 * persistent for main-items. The global environment can be saved and 431 * restored with PUSH/POP statements. 432 */ 433 434 struct hid_global { 435 unsigned usage_page; 436 __s32 logical_minimum; 437 __s32 logical_maximum; 438 __s32 physical_minimum; 439 __s32 physical_maximum; 440 __s32 unit_exponent; 441 unsigned unit; 442 unsigned report_id; 443 unsigned report_size; 444 unsigned report_count; 445 }; 446 447 /* 448 * This is the local environment. It is persistent up the next main-item. 449 */ 450 451 #define HID_MAX_USAGES 12288 452 #define HID_DEFAULT_NUM_COLLECTIONS 16 453 454 struct hid_local { 455 unsigned usage[HID_MAX_USAGES]; /* usage array */ 456 u8 usage_size[HID_MAX_USAGES]; /* usage size array */ 457 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ 458 unsigned usage_index; 459 unsigned usage_minimum; 460 unsigned delimiter_depth; 461 unsigned delimiter_branch; 462 }; 463 464 /* 465 * This is the collection stack. We climb up the stack to determine 466 * application and function of each field. 467 */ 468 469 struct hid_collection { 470 int parent_idx; /* device->collection */ 471 unsigned type; 472 unsigned usage; 473 unsigned level; 474 }; 475 476 struct hid_usage { 477 unsigned hid; /* hid usage code */ 478 unsigned collection_index; /* index into collection array */ 479 unsigned usage_index; /* index into usage array */ 480 __s8 resolution_multiplier;/* Effective Resolution Multiplier 481 (HUT v1.12, 4.3.1), default: 1 */ 482 /* hidinput data */ 483 __s8 wheel_factor; /* 120/resolution_multiplier */ 484 __u16 code; /* input driver code */ 485 __u8 type; /* input driver type */ 486 __s16 hat_min; /* hat switch fun */ 487 __s16 hat_max; /* ditto */ 488 __s16 hat_dir; /* ditto */ 489 __s16 wheel_accumulated; /* hi-res wheel */ 490 }; 491 492 struct hid_input; 493 494 struct hid_field { 495 unsigned physical; /* physical usage for this field */ 496 unsigned logical; /* logical usage for this field */ 497 unsigned application; /* application usage for this field */ 498 struct hid_usage *usage; /* usage table for this function */ 499 unsigned maxusage; /* maximum usage index */ 500 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ 501 unsigned report_offset; /* bit offset in the report */ 502 unsigned report_size; /* size of this field in the report */ 503 unsigned report_count; /* number of this field in the report */ 504 unsigned report_type; /* (input,output,feature) */ 505 __s32 *value; /* last known value(s) */ 506 __s32 *new_value; /* newly read value(s) */ 507 __s32 *usages_priorities; /* priority of each usage when reading the report 508 * bits 8-16 are reserved for hid-input usage 509 */ 510 __s32 logical_minimum; 511 __s32 logical_maximum; 512 __s32 physical_minimum; 513 __s32 physical_maximum; 514 __s32 unit_exponent; 515 unsigned unit; 516 bool ignored; /* this field is ignored in this event */ 517 struct hid_report *report; /* associated report */ 518 unsigned index; /* index into report->field[] */ 519 /* hidinput data */ 520 struct hid_input *hidinput; /* associated input structure */ 521 __u16 dpad; /* dpad input code */ 522 unsigned int slot_idx; /* slot index in a report */ 523 }; 524 525 #define HID_MAX_FIELDS 256 526 527 struct hid_field_entry { 528 struct list_head list; 529 struct hid_field *field; 530 unsigned int index; 531 __s32 priority; 532 }; 533 534 struct hid_report { 535 struct list_head list; 536 struct list_head hidinput_list; 537 struct list_head field_entry_list; /* ordered list of input fields */ 538 unsigned int id; /* id of this report */ 539 enum hid_report_type type; /* report type */ 540 unsigned int application; /* application usage for this report */ 541 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ 542 struct hid_field_entry *field_entries; /* allocated memory of input field_entry */ 543 unsigned maxfield; /* maximum valid field index */ 544 unsigned size; /* size of the report (bits) */ 545 struct hid_device *device; /* associated device */ 546 547 /* tool related state */ 548 bool tool_active; /* whether the current tool is active */ 549 unsigned int tool; /* BTN_TOOL_* */ 550 }; 551 552 #define HID_MAX_IDS 256 553 554 struct hid_report_enum { 555 unsigned numbered; 556 struct list_head report_list; 557 struct hid_report *report_id_hash[HID_MAX_IDS]; 558 }; 559 560 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ 561 #define HID_MAX_BUFFER_SIZE 16384 /* 16kb */ 562 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ 563 #define HID_OUTPUT_FIFO_SIZE 64 564 565 struct hid_control_fifo { 566 unsigned char dir; 567 struct hid_report *report; 568 char *raw_report; 569 }; 570 571 struct hid_output_fifo { 572 struct hid_report *report; 573 char *raw_report; 574 }; 575 576 #define HID_CLAIMED_INPUT BIT(0) 577 #define HID_CLAIMED_HIDDEV BIT(1) 578 #define HID_CLAIMED_HIDRAW BIT(2) 579 #define HID_CLAIMED_DRIVER BIT(3) 580 581 #define HID_STAT_ADDED BIT(0) 582 #define HID_STAT_PARSED BIT(1) 583 #define HID_STAT_DUP_DETECTED BIT(2) 584 #define HID_STAT_REPROBED BIT(3) 585 586 struct hid_input { 587 struct list_head list; 588 struct hid_report *report; 589 struct input_dev *input; 590 const char *name; 591 struct list_head reports; /* the list of reports */ 592 unsigned int application; /* application usage for this input */ 593 bool registered; 594 }; 595 596 enum hid_type { 597 HID_TYPE_OTHER = 0, 598 HID_TYPE_USBMOUSE, 599 HID_TYPE_USBNONE 600 }; 601 602 enum hid_battery_status { 603 HID_BATTERY_UNKNOWN = 0, 604 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */ 605 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */ 606 }; 607 608 struct hid_driver; 609 struct hid_ll_driver; 610 611 struct hid_device { 612 const __u8 *dev_rdesc; /* device report descriptor */ 613 const __u8 *bpf_rdesc; /* bpf modified report descriptor, if any */ 614 const __u8 *rdesc; /* currently used report descriptor */ 615 unsigned int dev_rsize; 616 unsigned int bpf_rsize; 617 unsigned int rsize; 618 unsigned int collection_size; /* Number of allocated hid_collections */ 619 struct hid_collection *collection; /* List of HID collections */ 620 unsigned int maxcollection; /* Number of parsed collections */ 621 unsigned int maxapplication; /* Number of applications */ 622 __u16 bus; /* BUS ID */ 623 __u16 group; /* Report group */ 624 __u32 vendor; /* Vendor ID */ 625 __u32 product; /* Product ID */ 626 __u32 version; /* HID version */ 627 enum hid_type type; /* device type (mouse, kbd, ...) */ 628 unsigned country; /* HID country */ 629 struct hid_report_enum report_enum[HID_REPORT_TYPES]; 630 struct work_struct led_work; /* delayed LED worker */ 631 632 struct semaphore driver_input_lock; /* protects the current driver */ 633 struct device dev; /* device */ 634 struct hid_driver *driver; 635 void *devres_group_id; /* ID of probe devres group */ 636 637 const struct hid_ll_driver *ll_driver; 638 struct mutex ll_open_lock; 639 unsigned int ll_open_count; 640 641 #ifdef CONFIG_HID_BATTERY_STRENGTH 642 /* 643 * Power supply information for HID devices which report 644 * battery strength. power_supply was successfully registered if 645 * battery is non-NULL. 646 */ 647 struct power_supply *battery; 648 __s32 battery_capacity; 649 __s32 battery_min; 650 __s32 battery_max; 651 __s32 battery_report_type; 652 __s32 battery_report_id; 653 __s32 battery_charge_status; 654 enum hid_battery_status battery_status; 655 bool battery_avoid_query; 656 ktime_t battery_ratelimit_time; 657 #endif 658 659 unsigned long status; /* see STAT flags above */ 660 unsigned claimed; /* Claimed by hidinput, hiddev? */ 661 unsigned quirks; /* Various quirks the device can pull on us */ 662 unsigned initial_quirks; /* Initial set of quirks supplied when creating device */ 663 bool io_started; /* If IO has started */ 664 665 struct list_head inputs; /* The list of inputs */ 666 void *hiddev; /* The hiddev structure */ 667 void *hidraw; 668 669 char name[128]; /* Device name */ 670 char phys[64]; /* Device physical location */ 671 char uniq[64]; /* Device unique identifier (serial #) */ 672 673 void *driver_data; 674 675 /* temporary hid_ff handling (until moved to the drivers) */ 676 int (*ff_init)(struct hid_device *); 677 678 /* hiddev event handler */ 679 int (*hiddev_connect)(struct hid_device *, unsigned int); 680 void (*hiddev_disconnect)(struct hid_device *); 681 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, 682 struct hid_usage *, __s32); 683 void (*hiddev_report_event) (struct hid_device *, struct hid_report *); 684 685 /* debugging support via debugfs */ 686 unsigned short debug; 687 struct dentry *debug_dir; 688 struct dentry *debug_rdesc; 689 struct dentry *debug_events; 690 struct list_head debug_list; 691 spinlock_t debug_list_lock; 692 wait_queue_head_t debug_wait; 693 struct kref ref; 694 695 unsigned int id; /* system unique id */ 696 697 #ifdef CONFIG_HID_BPF 698 struct hid_bpf bpf; /* hid-bpf data */ 699 #endif /* CONFIG_HID_BPF */ 700 }; 701 702 void hiddev_free(struct kref *ref); 703 704 #define to_hid_device(pdev) \ 705 container_of(pdev, struct hid_device, dev) 706 707 static inline void *hid_get_drvdata(struct hid_device *hdev) 708 { 709 return dev_get_drvdata(&hdev->dev); 710 } 711 712 static inline void hid_set_drvdata(struct hid_device *hdev, void *data) 713 { 714 dev_set_drvdata(&hdev->dev, data); 715 } 716 717 #define HID_GLOBAL_STACK_SIZE 4 718 #define HID_COLLECTION_STACK_SIZE 4 719 720 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0) 721 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1) 722 #define HID_SCAN_FLAG_GD_POINTER BIT(2) 723 724 struct hid_parser { 725 struct hid_global global; 726 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; 727 unsigned int global_stack_ptr; 728 struct hid_local local; 729 unsigned int *collection_stack; 730 unsigned int collection_stack_ptr; 731 unsigned int collection_stack_size; 732 struct hid_device *device; 733 unsigned int scan_flags; 734 }; 735 736 struct hid_class_descriptor { 737 __u8 bDescriptorType; 738 __le16 wDescriptorLength; 739 } __attribute__ ((packed)); 740 741 struct hid_descriptor { 742 __u8 bLength; 743 __u8 bDescriptorType; 744 __le16 bcdHID; 745 __u8 bCountryCode; 746 __u8 bNumDescriptors; 747 struct hid_class_descriptor rpt_desc; 748 749 struct hid_class_descriptor opt_descs[]; 750 } __attribute__ ((packed)); 751 752 #define HID_DEVICE(b, g, ven, prod) \ 753 .bus = (b), .group = (g), .vendor = (ven), .product = (prod) 754 #define HID_USB_DEVICE(ven, prod) \ 755 .bus = BUS_USB, .vendor = (ven), .product = (prod) 756 #define HID_BLUETOOTH_DEVICE(ven, prod) \ 757 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) 758 #define HID_I2C_DEVICE(ven, prod) \ 759 .bus = BUS_I2C, .vendor = (ven), .product = (prod) 760 761 #define HID_REPORT_ID(rep) \ 762 .report_type = (rep) 763 #define HID_USAGE_ID(uhid, utype, ucode) \ 764 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) 765 /* we don't want to catch types and codes equal to 0 */ 766 #define HID_TERMINATOR (HID_ANY_ID - 1) 767 768 struct hid_report_id { 769 __u32 report_type; 770 }; 771 struct hid_usage_id { 772 __u32 usage_hid; 773 __u32 usage_type; 774 __u32 usage_code; 775 }; 776 777 /** 778 * struct hid_driver 779 * @name: driver name (e.g. "Footech_bar-wheel") 780 * @id_table: which devices is this driver for (must be non-NULL for probe 781 * to be called) 782 * @dyn_list: list of dynamically added device ids 783 * @dyn_lock: lock protecting @dyn_list 784 * @match: check if the given device is handled by this driver 785 * @probe: new device inserted 786 * @remove: device removed (NULL if not a hot-plug capable driver) 787 * @report_table: on which reports to call raw_event (NULL means all) 788 * @raw_event: if report in report_table, this hook is called (NULL means nop) 789 * @usage_table: on which events to call event (NULL means all) 790 * @event: if usage in usage_table, this hook is called (NULL means nop) 791 * @report: this hook is called after parsing a report (NULL means nop) 792 * @report_fixup: called before report descriptor parsing (NULL means nop) 793 * @input_mapping: invoked on input registering before mapping an usage 794 * @input_mapped: invoked on input registering after mapping an usage 795 * @input_configured: invoked just before the device is registered 796 * @feature_mapping: invoked on feature registering 797 * @suspend: invoked on suspend (NULL means nop) 798 * @resume: invoked on resume if device was not reset (NULL means nop) 799 * @reset_resume: invoked on resume if device was reset (NULL means nop) 800 * @on_hid_hw_open: invoked when hid core opens first instance (NULL means nop) 801 * @on_hid_hw_close: invoked when hid core closes last instance (NULL means nop) 802 * 803 * probe should return -errno on error, or 0 on success. During probe, 804 * input will not be passed to raw_event unless hid_device_io_start is 805 * called. 806 * 807 * raw_event and event should return negative on error, any other value will 808 * pass the event on to .event() typically return 0 for success. 809 * 810 * input_mapping shall return a negative value to completely ignore this usage 811 * (e.g. doubled or invalid usage), zero to continue with parsing of this 812 * usage by generic code (no special handling needed) or positive to skip 813 * generic parsing (needed special handling which was done in the hook already) 814 * input_mapped shall return negative to inform the layer that this usage 815 * should not be considered for further processing or zero to notify that 816 * no processing was performed and should be done in a generic manner 817 * Both these functions may be NULL which means the same behavior as returning 818 * zero from them. 819 */ 820 struct hid_driver { 821 char *name; 822 const struct hid_device_id *id_table; 823 824 struct list_head dyn_list; 825 spinlock_t dyn_lock; 826 827 bool (*match)(struct hid_device *dev, bool ignore_special_driver); 828 int (*probe)(struct hid_device *dev, const struct hid_device_id *id); 829 void (*remove)(struct hid_device *dev); 830 831 const struct hid_report_id *report_table; 832 int (*raw_event)(struct hid_device *hdev, struct hid_report *report, 833 u8 *data, int size); 834 const struct hid_usage_id *usage_table; 835 int (*event)(struct hid_device *hdev, struct hid_field *field, 836 struct hid_usage *usage, __s32 value); 837 void (*report)(struct hid_device *hdev, struct hid_report *report); 838 839 const __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, 840 unsigned int *size); 841 842 int (*input_mapping)(struct hid_device *hdev, 843 struct hid_input *hidinput, struct hid_field *field, 844 struct hid_usage *usage, unsigned long **bit, int *max); 845 int (*input_mapped)(struct hid_device *hdev, 846 struct hid_input *hidinput, struct hid_field *field, 847 struct hid_usage *usage, unsigned long **bit, int *max); 848 int (*input_configured)(struct hid_device *hdev, 849 struct hid_input *hidinput); 850 void (*feature_mapping)(struct hid_device *hdev, 851 struct hid_field *field, 852 struct hid_usage *usage); 853 854 int (*suspend)(struct hid_device *hdev, pm_message_t message); 855 int (*resume)(struct hid_device *hdev); 856 int (*reset_resume)(struct hid_device *hdev); 857 void (*on_hid_hw_open)(struct hid_device *hdev); 858 void (*on_hid_hw_close)(struct hid_device *hdev); 859 860 /* private: */ 861 struct device_driver driver; 862 }; 863 864 #define to_hid_driver(pdrv) \ 865 container_of(pdrv, struct hid_driver, driver) 866 867 /** 868 * struct hid_ll_driver - low level driver callbacks 869 * @start: called on probe to start the device 870 * @stop: called on remove 871 * @open: called by input layer on open 872 * @close: called by input layer on close 873 * @power: request underlying hardware to enter requested power mode 874 * @parse: this method is called only once to parse the device data, 875 * shouldn't allocate anything to not leak memory 876 * @request: send report request to device (e.g. feature report) 877 * @wait: wait for buffered io to complete (send/recv reports) 878 * @raw_request: send raw report request to device (e.g. feature report) 879 * @output_report: send output report to device 880 * @idle: send idle request to device 881 * @may_wakeup: return if device may act as a wakeup source during system-suspend 882 * @max_buffer_size: over-ride maximum data buffer size (default: HID_MAX_BUFFER_SIZE) 883 */ 884 struct hid_ll_driver { 885 int (*start)(struct hid_device *hdev); 886 void (*stop)(struct hid_device *hdev); 887 888 int (*open)(struct hid_device *hdev); 889 void (*close)(struct hid_device *hdev); 890 891 int (*power)(struct hid_device *hdev, int level); 892 893 int (*parse)(struct hid_device *hdev); 894 895 void (*request)(struct hid_device *hdev, 896 struct hid_report *report, int reqtype); 897 898 int (*wait)(struct hid_device *hdev); 899 900 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, 901 __u8 *buf, size_t len, unsigned char rtype, 902 int reqtype); 903 904 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len); 905 906 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); 907 bool (*may_wakeup)(struct hid_device *hdev); 908 909 unsigned int max_buffer_size; 910 }; 911 912 extern bool hid_is_usb(const struct hid_device *hdev); 913 914 #define PM_HINT_FULLON 1<<5 915 #define PM_HINT_NORMAL 1<<1 916 917 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ 918 /* We ignore a few input applications that are not widely used */ 919 #define IS_INPUT_APPLICATION(a) \ 920 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \ 921 || ((a >= HID_DG_DIGITIZER) && (a <= HID_DG_WHITEBOARD)) \ 922 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \ 923 || (a == HID_GD_WIRELESS_RADIO_CTLS)) 924 925 /* HID core API */ 926 927 extern bool hid_ignore(struct hid_device *); 928 extern int hid_add_device(struct hid_device *); 929 extern void hid_destroy_device(struct hid_device *); 930 931 extern const struct bus_type hid_bus_type; 932 933 extern int __must_check __hid_register_driver(struct hid_driver *, 934 struct module *, const char *mod_name); 935 936 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 937 #define hid_register_driver(driver) \ 938 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 939 940 extern void hid_unregister_driver(struct hid_driver *); 941 942 /** 943 * module_hid_driver() - Helper macro for registering a HID driver 944 * @__hid_driver: hid_driver struct 945 * 946 * Helper macro for HID drivers which do not do anything special in module 947 * init/exit. This eliminates a lot of boilerplate. Each module may only 948 * use this macro once, and calling it replaces module_init() and module_exit() 949 */ 950 #define module_hid_driver(__hid_driver) \ 951 module_driver(__hid_driver, hid_register_driver, \ 952 hid_unregister_driver) 953 954 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); 955 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); 956 extern int hidinput_connect(struct hid_device *hid, unsigned int force); 957 extern void hidinput_disconnect(struct hid_device *); 958 959 struct hid_field *hid_find_field(struct hid_device *hdev, unsigned int report_type, 960 unsigned int application, unsigned int usage); 961 int hid_set_field(struct hid_field *, unsigned, __s32); 962 int hid_input_report(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size, 963 int interrupt); 964 struct hid_field *hidinput_get_led_field(struct hid_device *hid); 965 unsigned int hidinput_count_leds(struct hid_device *hid); 966 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); 967 void hid_output_report(struct hid_report *report, __u8 *data); 968 int __hid_request(struct hid_device *hid, struct hid_report *rep, enum hid_class_request reqtype); 969 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); 970 struct hid_device *hid_allocate_device(void); 971 struct hid_report *hid_register_report(struct hid_device *device, 972 enum hid_report_type type, unsigned int id, 973 unsigned int application); 974 int hid_parse_report(struct hid_device *hid, const __u8 *start, unsigned size); 975 struct hid_report *hid_validate_values(struct hid_device *hid, 976 enum hid_report_type type, unsigned int id, 977 unsigned int field_index, 978 unsigned int report_counts); 979 980 void hid_setup_resolution_multiplier(struct hid_device *hid); 981 int hid_open_report(struct hid_device *device); 982 int hid_check_keys_pressed(struct hid_device *hid); 983 int hid_connect(struct hid_device *hid, unsigned int connect_mask); 984 void hid_disconnect(struct hid_device *hid); 985 bool hid_match_one_id(const struct hid_device *hdev, 986 const struct hid_device_id *id); 987 const struct hid_device_id *hid_match_id(const struct hid_device *hdev, 988 const struct hid_device_id *id); 989 const struct hid_device_id *hid_match_device(struct hid_device *hdev, 990 struct hid_driver *hdrv); 991 bool hid_compare_device_paths(struct hid_device *hdev_a, 992 struct hid_device *hdev_b, char separator); 993 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report, 994 unsigned offset, unsigned n); 995 996 #ifdef CONFIG_PM 997 int hid_driver_suspend(struct hid_device *hdev, pm_message_t state); 998 int hid_driver_reset_resume(struct hid_device *hdev); 999 int hid_driver_resume(struct hid_device *hdev); 1000 #else 1001 static inline int hid_driver_suspend(struct hid_device *hdev, pm_message_t state) { return 0; } 1002 static inline int hid_driver_reset_resume(struct hid_device *hdev) { return 0; } 1003 static inline int hid_driver_resume(struct hid_device *hdev) { return 0; } 1004 #endif 1005 1006 /** 1007 * hid_device_io_start - enable HID input during probe, remove 1008 * 1009 * @hid: the device 1010 * 1011 * This should only be called during probe or remove and only be 1012 * called by the thread calling probe or remove. It will allow 1013 * incoming packets to be delivered to the driver. 1014 */ 1015 static inline void hid_device_io_start(struct hid_device *hid) { 1016 if (hid->io_started) { 1017 dev_warn(&hid->dev, "io already started\n"); 1018 return; 1019 } 1020 hid->io_started = true; 1021 up(&hid->driver_input_lock); 1022 } 1023 1024 /** 1025 * hid_device_io_stop - disable HID input during probe, remove 1026 * 1027 * @hid: the device 1028 * 1029 * Should only be called after hid_device_io_start. It will prevent 1030 * incoming packets from going to the driver for the duration of 1031 * probe, remove. If called during probe, packets will still go to the 1032 * driver after probe is complete. This function should only be called 1033 * by the thread calling probe or remove. 1034 */ 1035 static inline void hid_device_io_stop(struct hid_device *hid) { 1036 if (!hid->io_started) { 1037 dev_warn(&hid->dev, "io already stopped\n"); 1038 return; 1039 } 1040 hid->io_started = false; 1041 down(&hid->driver_input_lock); 1042 } 1043 1044 /** 1045 * hid_map_usage - map usage input bits 1046 * 1047 * @hidinput: hidinput which we are interested in 1048 * @usage: usage to fill in 1049 * @bit: pointer to input->{}bit (out parameter) 1050 * @max: maximal valid usage->code to consider later (out parameter) 1051 * @type: input event type (EV_KEY, EV_REL, ...) 1052 * @c: code which corresponds to this usage and type 1053 * 1054 * The value pointed to by @bit will be set to NULL if either @type is 1055 * an unhandled event type, or if @c is out of range for @type. This 1056 * can be used as an error condition. 1057 */ 1058 static inline void hid_map_usage(struct hid_input *hidinput, 1059 struct hid_usage *usage, unsigned long **bit, int *max, 1060 __u8 type, unsigned int c) 1061 { 1062 struct input_dev *input = hidinput->input; 1063 unsigned long *bmap = NULL; 1064 unsigned int limit = 0; 1065 1066 switch (type) { 1067 case EV_ABS: 1068 bmap = input->absbit; 1069 limit = ABS_MAX; 1070 break; 1071 case EV_REL: 1072 bmap = input->relbit; 1073 limit = REL_MAX; 1074 break; 1075 case EV_KEY: 1076 bmap = input->keybit; 1077 limit = KEY_MAX; 1078 break; 1079 case EV_LED: 1080 bmap = input->ledbit; 1081 limit = LED_MAX; 1082 break; 1083 case EV_MSC: 1084 bmap = input->mscbit; 1085 limit = MSC_MAX; 1086 break; 1087 } 1088 1089 if (unlikely(c > limit || !bmap)) { 1090 pr_warn_ratelimited("%s: Invalid code %d type %d\n", 1091 input->name, c, type); 1092 *bit = NULL; 1093 return; 1094 } 1095 1096 usage->type = type; 1097 usage->code = c; 1098 *max = limit; 1099 *bit = bmap; 1100 } 1101 1102 /** 1103 * hid_map_usage_clear - map usage input bits and clear the input bit 1104 * 1105 * @hidinput: hidinput which we are interested in 1106 * @usage: usage to fill in 1107 * @bit: pointer to input->{}bit (out parameter) 1108 * @max: maximal valid usage->code to consider later (out parameter) 1109 * @type: input event type (EV_KEY, EV_REL, ...) 1110 * @c: code which corresponds to this usage and type 1111 * 1112 * The same as hid_map_usage, except the @c bit is also cleared in supported 1113 * bits (@bit). 1114 */ 1115 static inline void hid_map_usage_clear(struct hid_input *hidinput, 1116 struct hid_usage *usage, unsigned long **bit, int *max, 1117 __u8 type, __u16 c) 1118 { 1119 hid_map_usage(hidinput, usage, bit, max, type, c); 1120 if (*bit) 1121 clear_bit(usage->code, *bit); 1122 } 1123 1124 /** 1125 * hid_parse - parse HW reports 1126 * 1127 * @hdev: hid device 1128 * 1129 * Call this from probe after you set up the device (if needed). Your 1130 * report_fixup will be called (if non-NULL) after reading raw report from 1131 * device before passing it to hid layer for real parsing. 1132 */ 1133 static inline int __must_check hid_parse(struct hid_device *hdev) 1134 { 1135 return hid_open_report(hdev); 1136 } 1137 1138 int __must_check hid_hw_start(struct hid_device *hdev, 1139 unsigned int connect_mask); 1140 void hid_hw_stop(struct hid_device *hdev); 1141 int __must_check hid_hw_open(struct hid_device *hdev); 1142 void hid_hw_close(struct hid_device *hdev); 1143 void hid_hw_request(struct hid_device *hdev, 1144 struct hid_report *report, enum hid_class_request reqtype); 1145 int __hid_hw_raw_request(struct hid_device *hdev, 1146 unsigned char reportnum, __u8 *buf, 1147 size_t len, enum hid_report_type rtype, 1148 enum hid_class_request reqtype, 1149 __u64 source, bool from_bpf); 1150 int __hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len, __u64 source, 1151 bool from_bpf); 1152 int hid_hw_raw_request(struct hid_device *hdev, 1153 unsigned char reportnum, __u8 *buf, 1154 size_t len, enum hid_report_type rtype, 1155 enum hid_class_request reqtype); 1156 int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, size_t len); 1157 1158 /** 1159 * hid_hw_power - requests underlying HW to go into given power mode 1160 * 1161 * @hdev: hid device 1162 * @level: requested power level (one of %PM_HINT_* defines) 1163 * 1164 * This function requests underlying hardware to enter requested power 1165 * mode. 1166 */ 1167 1168 static inline int hid_hw_power(struct hid_device *hdev, int level) 1169 { 1170 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; 1171 } 1172 1173 1174 /** 1175 * hid_hw_idle - send idle request to device 1176 * 1177 * @hdev: hid device 1178 * @report: report to control 1179 * @idle: idle state 1180 * @reqtype: hid request type 1181 */ 1182 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, 1183 enum hid_class_request reqtype) 1184 { 1185 if (hdev->ll_driver->idle) 1186 return hdev->ll_driver->idle(hdev, report, idle, reqtype); 1187 1188 return 0; 1189 } 1190 1191 /** 1192 * hid_hw_may_wakeup - return if the hid device may act as a wakeup source during system-suspend 1193 * 1194 * @hdev: hid device 1195 */ 1196 static inline bool hid_hw_may_wakeup(struct hid_device *hdev) 1197 { 1198 if (hdev->ll_driver->may_wakeup) 1199 return hdev->ll_driver->may_wakeup(hdev); 1200 1201 if (hdev->dev.parent) 1202 return device_may_wakeup(hdev->dev.parent); 1203 1204 return false; 1205 } 1206 1207 /** 1208 * hid_hw_wait - wait for buffered io to complete 1209 * 1210 * @hdev: hid device 1211 */ 1212 static inline void hid_hw_wait(struct hid_device *hdev) 1213 { 1214 if (hdev->ll_driver->wait) 1215 hdev->ll_driver->wait(hdev); 1216 } 1217 1218 /** 1219 * hid_report_len - calculate the report length 1220 * 1221 * @report: the report whose length we want to know 1222 * 1223 * The length counts the report ID byte, but only if the ID is nonzero 1224 * and therefore is included in the report. Reports whose ID is zero 1225 * never include an ID byte. 1226 */ 1227 static inline u32 hid_report_len(struct hid_report *report) 1228 { 1229 return DIV_ROUND_UP(report->size, 8) + (report->id > 0); 1230 } 1231 1232 int hid_report_raw_event(struct hid_device *hid, enum hid_report_type type, u8 *data, u32 size, 1233 int interrupt); 1234 1235 /* HID quirks API */ 1236 unsigned long hid_lookup_quirk(const struct hid_device *hdev); 1237 int hid_quirks_init(char **quirks_param, __u16 bus, int count); 1238 void hid_quirks_exit(__u16 bus); 1239 1240 #define dbg_hid(fmt, ...) pr_debug("%s: " fmt, __FILE__, ##__VA_ARGS__) 1241 1242 #define hid_err(hid, fmt, ...) \ 1243 dev_err(&(hid)->dev, fmt, ##__VA_ARGS__) 1244 #define hid_notice(hid, fmt, ...) \ 1245 dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__) 1246 #define hid_warn(hid, fmt, ...) \ 1247 dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__) 1248 #define hid_warn_ratelimited(hid, fmt, ...) \ 1249 dev_warn_ratelimited(&(hid)->dev, fmt, ##__VA_ARGS__) 1250 #define hid_info(hid, fmt, ...) \ 1251 dev_info(&(hid)->dev, fmt, ##__VA_ARGS__) 1252 #define hid_dbg(hid, fmt, ...) \ 1253 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__) 1254 1255 #define hid_err_once(hid, fmt, ...) \ 1256 dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__) 1257 #define hid_notice_once(hid, fmt, ...) \ 1258 dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__) 1259 #define hid_warn_once(hid, fmt, ...) \ 1260 dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__) 1261 #define hid_info_once(hid, fmt, ...) \ 1262 dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__) 1263 #define hid_dbg_once(hid, fmt, ...) \ 1264 dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__) 1265 1266 #endif 1267