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