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