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_CONSUMER 0x000c0000 163 #define HID_UP_DIGITIZER 0x000d0000 164 #define HID_UP_PID 0x000f0000 165 #define HID_UP_HPVENDOR 0xff7f0000 166 #define HID_UP_HPVENDOR2 0xff010000 167 #define HID_UP_MSVENDOR 0xff000000 168 #define HID_UP_CUSTOM 0x00ff0000 169 #define HID_UP_LOGIVENDOR 0xffbc0000 170 #define HID_UP_SENSOR 0x00200000 171 172 #define HID_USAGE 0x0000ffff 173 174 #define HID_GD_POINTER 0x00010001 175 #define HID_GD_MOUSE 0x00010002 176 #define HID_GD_JOYSTICK 0x00010004 177 #define HID_GD_GAMEPAD 0x00010005 178 #define HID_GD_KEYBOARD 0x00010006 179 #define HID_GD_KEYPAD 0x00010007 180 #define HID_GD_MULTIAXIS 0x00010008 181 #define HID_GD_X 0x00010030 182 #define HID_GD_Y 0x00010031 183 #define HID_GD_Z 0x00010032 184 #define HID_GD_RX 0x00010033 185 #define HID_GD_RY 0x00010034 186 #define HID_GD_RZ 0x00010035 187 #define HID_GD_SLIDER 0x00010036 188 #define HID_GD_DIAL 0x00010037 189 #define HID_GD_WHEEL 0x00010038 190 #define HID_GD_HATSWITCH 0x00010039 191 #define HID_GD_BUFFER 0x0001003a 192 #define HID_GD_BYTECOUNT 0x0001003b 193 #define HID_GD_MOTION 0x0001003c 194 #define HID_GD_START 0x0001003d 195 #define HID_GD_SELECT 0x0001003e 196 #define HID_GD_VX 0x00010040 197 #define HID_GD_VY 0x00010041 198 #define HID_GD_VZ 0x00010042 199 #define HID_GD_VBRX 0x00010043 200 #define HID_GD_VBRY 0x00010044 201 #define HID_GD_VBRZ 0x00010045 202 #define HID_GD_VNO 0x00010046 203 #define HID_GD_FEATURE 0x00010047 204 #define HID_GD_UP 0x00010090 205 #define HID_GD_DOWN 0x00010091 206 #define HID_GD_RIGHT 0x00010092 207 #define HID_GD_LEFT 0x00010093 208 209 #define HID_DC_BATTERYSTRENGTH 0x00060020 210 211 #define HID_DG_DIGITIZER 0x000d0001 212 #define HID_DG_PEN 0x000d0002 213 #define HID_DG_LIGHTPEN 0x000d0003 214 #define HID_DG_TOUCHSCREEN 0x000d0004 215 #define HID_DG_TOUCHPAD 0x000d0005 216 #define HID_DG_STYLUS 0x000d0020 217 #define HID_DG_PUCK 0x000d0021 218 #define HID_DG_FINGER 0x000d0022 219 #define HID_DG_TIPPRESSURE 0x000d0030 220 #define HID_DG_BARRELPRESSURE 0x000d0031 221 #define HID_DG_INRANGE 0x000d0032 222 #define HID_DG_TOUCH 0x000d0033 223 #define HID_DG_UNTOUCH 0x000d0034 224 #define HID_DG_TAP 0x000d0035 225 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 226 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a 227 #define HID_DG_INVERT 0x000d003c 228 #define HID_DG_TIPSWITCH 0x000d0042 229 #define HID_DG_TIPSWITCH2 0x000d0043 230 #define HID_DG_BARRELSWITCH 0x000d0044 231 #define HID_DG_ERASER 0x000d0045 232 #define HID_DG_TABLETPICK 0x000d0046 233 /* 234 * as of May 20, 2009 the usages below are not yet in the official USB spec 235 * but are being pushed by Microsft as described in their paper "Digitizer 236 * Drivers for Windows Touch and Pen-Based Computers" 237 */ 238 #define HID_DG_CONFIDENCE 0x000d0047 239 #define HID_DG_WIDTH 0x000d0048 240 #define HID_DG_HEIGHT 0x000d0049 241 #define HID_DG_CONTACTID 0x000d0051 242 #define HID_DG_INPUTMODE 0x000d0052 243 #define HID_DG_DEVICEINDEX 0x000d0053 244 #define HID_DG_CONTACTCOUNT 0x000d0054 245 #define HID_DG_CONTACTMAX 0x000d0055 246 247 /* 248 * HID report types --- Ouch! HID spec says 1 2 3! 249 */ 250 251 #define HID_INPUT_REPORT 0 252 #define HID_OUTPUT_REPORT 1 253 #define HID_FEATURE_REPORT 2 254 255 #define HID_REPORT_TYPES 3 256 257 /* 258 * HID connect requests 259 */ 260 261 #define HID_CONNECT_HIDINPUT 0x01 262 #define HID_CONNECT_HIDINPUT_FORCE 0x02 263 #define HID_CONNECT_HIDRAW 0x04 264 #define HID_CONNECT_HIDDEV 0x08 265 #define HID_CONNECT_HIDDEV_FORCE 0x10 266 #define HID_CONNECT_FF 0x20 267 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ 268 HID_CONNECT_HIDDEV|HID_CONNECT_FF) 269 270 /* 271 * HID device quirks. 272 */ 273 274 /* 275 * Increase this if you need to configure more HID quirks at module load time 276 */ 277 #define MAX_USBHID_BOOT_QUIRKS 4 278 279 #define HID_QUIRK_INVERT 0x00000001 280 #define HID_QUIRK_NOTOUCH 0x00000002 281 #define HID_QUIRK_IGNORE 0x00000004 282 #define HID_QUIRK_NOGET 0x00000008 283 #define HID_QUIRK_HIDDEV_FORCE 0x00000010 284 #define HID_QUIRK_BADPAD 0x00000020 285 #define HID_QUIRK_MULTI_INPUT 0x00000040 286 #define HID_QUIRK_HIDINPUT_FORCE 0x00000080 287 #define HID_QUIRK_NO_EMPTY_INPUT 0x00000100 288 #define HID_QUIRK_NO_INIT_INPUT_REPORTS 0x00000200 289 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 290 #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000 291 #define HID_QUIRK_NO_INIT_REPORTS 0x20000000 292 #define HID_QUIRK_NO_IGNORE 0x40000000 293 #define HID_QUIRK_NO_INPUT_SYNC 0x80000000 294 295 /* 296 * HID device groups 297 */ 298 #define HID_GROUP_GENERIC 0x0001 299 #define HID_GROUP_MULTITOUCH 0x0002 300 #define HID_GROUP_SENSOR_HUB 0x0003 301 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 302 303 /* 304 * This is the global environment of the parser. This information is 305 * persistent for main-items. The global environment can be saved and 306 * restored with PUSH/POP statements. 307 */ 308 309 struct hid_global { 310 unsigned usage_page; 311 __s32 logical_minimum; 312 __s32 logical_maximum; 313 __s32 physical_minimum; 314 __s32 physical_maximum; 315 __s32 unit_exponent; 316 unsigned unit; 317 unsigned report_id; 318 unsigned report_size; 319 unsigned report_count; 320 }; 321 322 /* 323 * This is the local environment. It is persistent up the next main-item. 324 */ 325 326 #define HID_MAX_USAGES 12288 327 #define HID_DEFAULT_NUM_COLLECTIONS 16 328 329 struct hid_local { 330 unsigned usage[HID_MAX_USAGES]; /* usage array */ 331 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ 332 unsigned usage_index; 333 unsigned usage_minimum; 334 unsigned delimiter_depth; 335 unsigned delimiter_branch; 336 }; 337 338 /* 339 * This is the collection stack. We climb up the stack to determine 340 * application and function of each field. 341 */ 342 343 struct hid_collection { 344 unsigned type; 345 unsigned usage; 346 unsigned level; 347 }; 348 349 struct hid_usage { 350 unsigned hid; /* hid usage code */ 351 unsigned collection_index; /* index into collection array */ 352 unsigned usage_index; /* index into usage array */ 353 /* hidinput data */ 354 __u16 code; /* input driver code */ 355 __u8 type; /* input driver type */ 356 __s8 hat_min; /* hat switch fun */ 357 __s8 hat_max; /* ditto */ 358 __s8 hat_dir; /* ditto */ 359 }; 360 361 struct hid_input; 362 363 struct hid_field { 364 unsigned physical; /* physical usage for this field */ 365 unsigned logical; /* logical usage for this field */ 366 unsigned application; /* application usage for this field */ 367 struct hid_usage *usage; /* usage table for this function */ 368 unsigned maxusage; /* maximum usage index */ 369 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ 370 unsigned report_offset; /* bit offset in the report */ 371 unsigned report_size; /* size of this field in the report */ 372 unsigned report_count; /* number of this field in the report */ 373 unsigned report_type; /* (input,output,feature) */ 374 __s32 *value; /* last known value(s) */ 375 __s32 logical_minimum; 376 __s32 logical_maximum; 377 __s32 physical_minimum; 378 __s32 physical_maximum; 379 __s32 unit_exponent; 380 unsigned unit; 381 struct hid_report *report; /* associated report */ 382 unsigned index; /* index into report->field[] */ 383 /* hidinput data */ 384 struct hid_input *hidinput; /* associated input structure */ 385 __u16 dpad; /* dpad input code */ 386 }; 387 388 #define HID_MAX_FIELDS 256 389 390 struct hid_report { 391 struct list_head list; 392 unsigned id; /* id of this report */ 393 unsigned type; /* report type */ 394 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ 395 unsigned maxfield; /* maximum valid field index */ 396 unsigned size; /* size of the report (bits) */ 397 struct hid_device *device; /* associated device */ 398 }; 399 400 #define HID_MAX_IDS 256 401 402 struct hid_report_enum { 403 unsigned numbered; 404 struct list_head report_list; 405 struct hid_report *report_id_hash[HID_MAX_IDS]; 406 }; 407 408 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ 409 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ 410 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ 411 #define HID_OUTPUT_FIFO_SIZE 64 412 413 struct hid_control_fifo { 414 unsigned char dir; 415 struct hid_report *report; 416 char *raw_report; 417 }; 418 419 struct hid_output_fifo { 420 struct hid_report *report; 421 char *raw_report; 422 }; 423 424 #define HID_CLAIMED_INPUT 1 425 #define HID_CLAIMED_HIDDEV 2 426 #define HID_CLAIMED_HIDRAW 4 427 428 #define HID_STAT_ADDED 1 429 #define HID_STAT_PARSED 2 430 431 struct hid_input { 432 struct list_head list; 433 struct hid_report *report; 434 struct input_dev *input; 435 }; 436 437 enum hid_type { 438 HID_TYPE_OTHER = 0, 439 HID_TYPE_USBMOUSE, 440 HID_TYPE_USBNONE 441 }; 442 443 struct hid_driver; 444 struct hid_ll_driver; 445 446 struct hid_device { /* device report descriptor */ 447 __u8 *dev_rdesc; 448 unsigned dev_rsize; 449 __u8 *rdesc; 450 unsigned rsize; 451 struct hid_collection *collection; /* List of HID collections */ 452 unsigned collection_size; /* Number of allocated hid_collections */ 453 unsigned maxcollection; /* Number of parsed collections */ 454 unsigned maxapplication; /* Number of applications */ 455 __u16 bus; /* BUS ID */ 456 __u16 group; /* Report group */ 457 __u32 vendor; /* Vendor ID */ 458 __u32 product; /* Product ID */ 459 __u32 version; /* HID version */ 460 enum hid_type type; /* device type (mouse, kbd, ...) */ 461 unsigned country; /* HID country */ 462 struct hid_report_enum report_enum[HID_REPORT_TYPES]; 463 struct work_struct led_work; /* delayed LED worker */ 464 465 struct semaphore driver_lock; /* protects the current driver, except during input */ 466 struct semaphore driver_input_lock; /* protects the current driver */ 467 struct device dev; /* device */ 468 struct hid_driver *driver; 469 struct hid_ll_driver *ll_driver; 470 471 #ifdef CONFIG_HID_BATTERY_STRENGTH 472 /* 473 * Power supply information for HID devices which report 474 * battery strength. power_supply is registered iff 475 * battery.name is non-NULL. 476 */ 477 struct power_supply battery; 478 __s32 battery_min; 479 __s32 battery_max; 480 __s32 battery_report_type; 481 __s32 battery_report_id; 482 #endif 483 484 unsigned int status; /* see STAT flags above */ 485 unsigned claimed; /* Claimed by hidinput, hiddev? */ 486 unsigned quirks; /* Various quirks the device can pull on us */ 487 bool io_started; /* Protected by driver_lock. If IO has started */ 488 489 struct list_head inputs; /* The list of inputs */ 490 void *hiddev; /* The hiddev structure */ 491 void *hidraw; 492 int minor; /* Hiddev minor number */ 493 494 int open; /* is the device open by anyone? */ 495 char name[128]; /* Device name */ 496 char phys[64]; /* Device physical location */ 497 char uniq[64]; /* Device unique identifier (serial #) */ 498 499 void *driver_data; 500 501 /* temporary hid_ff handling (until moved to the drivers) */ 502 int (*ff_init)(struct hid_device *); 503 504 /* hiddev event handler */ 505 int (*hiddev_connect)(struct hid_device *, unsigned int); 506 void (*hiddev_disconnect)(struct hid_device *); 507 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, 508 struct hid_usage *, __s32); 509 void (*hiddev_report_event) (struct hid_device *, struct hid_report *); 510 511 /* handler for raw input (Get_Report) data, used by hidraw */ 512 int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char); 513 514 /* handler for raw output data, used by hidraw */ 515 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char); 516 517 /* debugging support via debugfs */ 518 unsigned short debug; 519 struct dentry *debug_dir; 520 struct dentry *debug_rdesc; 521 struct dentry *debug_events; 522 struct list_head debug_list; 523 spinlock_t debug_list_lock; 524 wait_queue_head_t debug_wait; 525 }; 526 527 static inline void *hid_get_drvdata(struct hid_device *hdev) 528 { 529 return dev_get_drvdata(&hdev->dev); 530 } 531 532 static inline void hid_set_drvdata(struct hid_device *hdev, void *data) 533 { 534 dev_set_drvdata(&hdev->dev, data); 535 } 536 537 #define HID_GLOBAL_STACK_SIZE 4 538 #define HID_COLLECTION_STACK_SIZE 4 539 540 #define HID_SCAN_FLAG_MT_WIN_8 0x00000001 541 542 struct hid_parser { 543 struct hid_global global; 544 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; 545 unsigned global_stack_ptr; 546 struct hid_local local; 547 unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; 548 unsigned collection_stack_ptr; 549 struct hid_device *device; 550 unsigned scan_flags; 551 }; 552 553 struct hid_class_descriptor { 554 __u8 bDescriptorType; 555 __le16 wDescriptorLength; 556 } __attribute__ ((packed)); 557 558 struct hid_descriptor { 559 __u8 bLength; 560 __u8 bDescriptorType; 561 __le16 bcdHID; 562 __u8 bCountryCode; 563 __u8 bNumDescriptors; 564 565 struct hid_class_descriptor desc[1]; 566 } __attribute__ ((packed)); 567 568 #define HID_DEVICE(b, g, ven, prod) \ 569 .bus = (b), .group = (g), .vendor = (ven), .product = (prod) 570 #define HID_USB_DEVICE(ven, prod) \ 571 .bus = BUS_USB, .vendor = (ven), .product = (prod) 572 #define HID_BLUETOOTH_DEVICE(ven, prod) \ 573 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) 574 575 #define HID_REPORT_ID(rep) \ 576 .report_type = (rep) 577 #define HID_USAGE_ID(uhid, utype, ucode) \ 578 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) 579 /* we don't want to catch types and codes equal to 0 */ 580 #define HID_TERMINATOR (HID_ANY_ID - 1) 581 582 struct hid_report_id { 583 __u32 report_type; 584 }; 585 struct hid_usage_id { 586 __u32 usage_hid; 587 __u32 usage_type; 588 __u32 usage_code; 589 }; 590 591 /** 592 * struct hid_driver 593 * @name: driver name (e.g. "Footech_bar-wheel") 594 * @id_table: which devices is this driver for (must be non-NULL for probe 595 * to be called) 596 * @dyn_list: list of dynamically added device ids 597 * @dyn_lock: lock protecting @dyn_list 598 * @probe: new device inserted 599 * @remove: device removed (NULL if not a hot-plug capable driver) 600 * @report_table: on which reports to call raw_event (NULL means all) 601 * @raw_event: if report in report_table, this hook is called (NULL means nop) 602 * @usage_table: on which events to call event (NULL means all) 603 * @event: if usage in usage_table, this hook is called (NULL means nop) 604 * @report: this hook is called after parsing a report (NULL means nop) 605 * @report_fixup: called before report descriptor parsing (NULL means nop) 606 * @input_mapping: invoked on input registering before mapping an usage 607 * @input_mapped: invoked on input registering after mapping an usage 608 * @input_configured: invoked just before the device is registered 609 * @feature_mapping: invoked on feature registering 610 * @suspend: invoked on suspend (NULL means nop) 611 * @resume: invoked on resume if device was not reset (NULL means nop) 612 * @reset_resume: invoked on resume if device was reset (NULL means nop) 613 * 614 * probe should return -errno on error, or 0 on success. During probe, 615 * input will not be passed to raw_event unless hid_device_io_start is 616 * called. 617 * 618 * raw_event and event should return 0 on no action performed, 1 when no 619 * further processing should be done and negative on error 620 * 621 * input_mapping shall return a negative value to completely ignore this usage 622 * (e.g. doubled or invalid usage), zero to continue with parsing of this 623 * usage by generic code (no special handling needed) or positive to skip 624 * generic parsing (needed special handling which was done in the hook already) 625 * input_mapped shall return negative to inform the layer that this usage 626 * should not be considered for further processing or zero to notify that 627 * no processing was performed and should be done in a generic manner 628 * Both these functions may be NULL which means the same behavior as returning 629 * zero from them. 630 */ 631 struct hid_driver { 632 char *name; 633 const struct hid_device_id *id_table; 634 635 struct list_head dyn_list; 636 spinlock_t dyn_lock; 637 638 int (*probe)(struct hid_device *dev, const struct hid_device_id *id); 639 void (*remove)(struct hid_device *dev); 640 641 const struct hid_report_id *report_table; 642 int (*raw_event)(struct hid_device *hdev, struct hid_report *report, 643 u8 *data, int size); 644 const struct hid_usage_id *usage_table; 645 int (*event)(struct hid_device *hdev, struct hid_field *field, 646 struct hid_usage *usage, __s32 value); 647 void (*report)(struct hid_device *hdev, struct hid_report *report); 648 649 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, 650 unsigned int *size); 651 652 int (*input_mapping)(struct hid_device *hdev, 653 struct hid_input *hidinput, struct hid_field *field, 654 struct hid_usage *usage, unsigned long **bit, int *max); 655 int (*input_mapped)(struct hid_device *hdev, 656 struct hid_input *hidinput, struct hid_field *field, 657 struct hid_usage *usage, unsigned long **bit, int *max); 658 void (*input_configured)(struct hid_device *hdev, 659 struct hid_input *hidinput); 660 void (*feature_mapping)(struct hid_device *hdev, 661 struct hid_field *field, 662 struct hid_usage *usage); 663 #ifdef CONFIG_PM 664 int (*suspend)(struct hid_device *hdev, pm_message_t message); 665 int (*resume)(struct hid_device *hdev); 666 int (*reset_resume)(struct hid_device *hdev); 667 #endif 668 /* private: */ 669 struct device_driver driver; 670 }; 671 672 /** 673 * hid_ll_driver - low level driver callbacks 674 * @start: called on probe to start the device 675 * @stop: called on remove 676 * @open: called by input layer on open 677 * @close: called by input layer on close 678 * @hidinput_input_event: event input event (e.g. ff or leds) 679 * @parse: this method is called only once to parse the device data, 680 * shouldn't allocate anything to not leak memory 681 * @request: send report request to device (e.g. feature report) 682 * @wait: wait for buffered io to complete (send/recv reports) 683 * @idle: send idle request to device 684 */ 685 struct hid_ll_driver { 686 int (*start)(struct hid_device *hdev); 687 void (*stop)(struct hid_device *hdev); 688 689 int (*open)(struct hid_device *hdev); 690 void (*close)(struct hid_device *hdev); 691 692 int (*power)(struct hid_device *hdev, int level); 693 694 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type, 695 unsigned int code, int value); 696 697 int (*parse)(struct hid_device *hdev); 698 699 void (*request)(struct hid_device *hdev, 700 struct hid_report *report, int reqtype); 701 702 int (*wait)(struct hid_device *hdev); 703 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); 704 705 }; 706 707 #define PM_HINT_FULLON 1<<5 708 #define PM_HINT_NORMAL 1<<1 709 710 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ 711 /* We ignore a few input applications that are not widely used */ 712 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) 713 714 /* HID core API */ 715 716 extern int hid_debug; 717 718 extern bool hid_ignore(struct hid_device *); 719 extern int hid_add_device(struct hid_device *); 720 extern void hid_destroy_device(struct hid_device *); 721 722 extern int __must_check __hid_register_driver(struct hid_driver *, 723 struct module *, const char *mod_name); 724 725 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 726 #define hid_register_driver(driver) \ 727 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 728 729 extern void hid_unregister_driver(struct hid_driver *); 730 731 /** 732 * module_hid_driver() - Helper macro for registering a HID driver 733 * @__hid_driver: hid_driver struct 734 * 735 * Helper macro for HID drivers which do not do anything special in module 736 * init/exit. This eliminates a lot of boilerplate. Each module may only 737 * use this macro once, and calling it replaces module_init() and module_exit() 738 */ 739 #define module_hid_driver(__hid_driver) \ 740 module_driver(__hid_driver, hid_register_driver, \ 741 hid_unregister_driver) 742 743 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); 744 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); 745 extern int hidinput_connect(struct hid_device *hid, unsigned int force); 746 extern void hidinput_disconnect(struct hid_device *); 747 748 int hid_set_field(struct hid_field *, unsigned, __s32); 749 int hid_input_report(struct hid_device *, int type, u8 *, int, int); 750 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); 751 struct hid_field *hidinput_get_led_field(struct hid_device *hid); 752 unsigned int hidinput_count_leds(struct hid_device *hid); 753 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); 754 void hid_output_report(struct hid_report *report, __u8 *data); 755 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); 756 struct hid_device *hid_allocate_device(void); 757 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); 758 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); 759 struct hid_report *hid_validate_values(struct hid_device *hid, 760 unsigned int type, unsigned int id, 761 unsigned int field_index, 762 unsigned int report_counts); 763 int hid_open_report(struct hid_device *device); 764 int hid_check_keys_pressed(struct hid_device *hid); 765 int hid_connect(struct hid_device *hid, unsigned int connect_mask); 766 void hid_disconnect(struct hid_device *hid); 767 const struct hid_device_id *hid_match_id(struct hid_device *hdev, 768 const struct hid_device_id *id); 769 s32 hid_snto32(__u32 value, unsigned n); 770 771 /** 772 * hid_device_io_start - enable HID input during probe, remove 773 * 774 * @hid - the device 775 * 776 * This should only be called during probe or remove and only be 777 * called by the thread calling probe or remove. It will allow 778 * incoming packets to be delivered to the driver. 779 */ 780 static inline void hid_device_io_start(struct hid_device *hid) { 781 if (hid->io_started) { 782 dev_warn(&hid->dev, "io already started"); 783 return; 784 } 785 hid->io_started = true; 786 up(&hid->driver_input_lock); 787 } 788 789 /** 790 * hid_device_io_stop - disable HID input during probe, remove 791 * 792 * @hid - the device 793 * 794 * Should only be called after hid_device_io_start. It will prevent 795 * incoming packets from going to the driver for the duration of 796 * probe, remove. If called during probe, packets will still go to the 797 * driver after probe is complete. This function should only be called 798 * by the thread calling probe or remove. 799 */ 800 static inline void hid_device_io_stop(struct hid_device *hid) { 801 if (!hid->io_started) { 802 dev_warn(&hid->dev, "io already stopped"); 803 return; 804 } 805 hid->io_started = false; 806 down(&hid->driver_input_lock); 807 } 808 809 /** 810 * hid_map_usage - map usage input bits 811 * 812 * @hidinput: hidinput which we are interested in 813 * @usage: usage to fill in 814 * @bit: pointer to input->{}bit (out parameter) 815 * @max: maximal valid usage->code to consider later (out parameter) 816 * @type: input event type (EV_KEY, EV_REL, ...) 817 * @c: code which corresponds to this usage and type 818 */ 819 static inline void hid_map_usage(struct hid_input *hidinput, 820 struct hid_usage *usage, unsigned long **bit, int *max, 821 __u8 type, __u16 c) 822 { 823 struct input_dev *input = hidinput->input; 824 825 usage->type = type; 826 usage->code = c; 827 828 switch (type) { 829 case EV_ABS: 830 *bit = input->absbit; 831 *max = ABS_MAX; 832 break; 833 case EV_REL: 834 *bit = input->relbit; 835 *max = REL_MAX; 836 break; 837 case EV_KEY: 838 *bit = input->keybit; 839 *max = KEY_MAX; 840 break; 841 case EV_LED: 842 *bit = input->ledbit; 843 *max = LED_MAX; 844 break; 845 } 846 } 847 848 /** 849 * hid_map_usage_clear - map usage input bits and clear the input bit 850 * 851 * The same as hid_map_usage, except the @c bit is also cleared in supported 852 * bits (@bit). 853 */ 854 static inline void hid_map_usage_clear(struct hid_input *hidinput, 855 struct hid_usage *usage, unsigned long **bit, int *max, 856 __u8 type, __u16 c) 857 { 858 hid_map_usage(hidinput, usage, bit, max, type, c); 859 clear_bit(c, *bit); 860 } 861 862 /** 863 * hid_parse - parse HW reports 864 * 865 * @hdev: hid device 866 * 867 * Call this from probe after you set up the device (if needed). Your 868 * report_fixup will be called (if non-NULL) after reading raw report from 869 * device before passing it to hid layer for real parsing. 870 */ 871 static inline int __must_check hid_parse(struct hid_device *hdev) 872 { 873 return hid_open_report(hdev); 874 } 875 876 /** 877 * hid_hw_start - start underlaying HW 878 * 879 * @hdev: hid device 880 * @connect_mask: which outputs to connect, see HID_CONNECT_* 881 * 882 * Call this in probe function *after* hid_parse. This will setup HW buffers 883 * and start the device (if not deffered to device open). hid_hw_stop must be 884 * called if this was successful. 885 */ 886 static inline int __must_check hid_hw_start(struct hid_device *hdev, 887 unsigned int connect_mask) 888 { 889 int ret = hdev->ll_driver->start(hdev); 890 if (ret || !connect_mask) 891 return ret; 892 ret = hid_connect(hdev, connect_mask); 893 if (ret) 894 hdev->ll_driver->stop(hdev); 895 return ret; 896 } 897 898 /** 899 * hid_hw_stop - stop underlaying HW 900 * 901 * @hdev: hid device 902 * 903 * This is usually called from remove function or from probe when something 904 * failed and hid_hw_start was called already. 905 */ 906 static inline void hid_hw_stop(struct hid_device *hdev) 907 { 908 hid_disconnect(hdev); 909 hdev->ll_driver->stop(hdev); 910 } 911 912 /** 913 * hid_hw_open - signal underlaying HW to start delivering events 914 * 915 * @hdev: hid device 916 * 917 * Tell underlying HW to start delivering events from the device. 918 * This function should be called sometime after successful call 919 * to hid_hiw_start(). 920 */ 921 static inline int __must_check hid_hw_open(struct hid_device *hdev) 922 { 923 return hdev->ll_driver->open(hdev); 924 } 925 926 /** 927 * hid_hw_close - signal underlaying HW to stop delivering events 928 * 929 * @hdev: hid device 930 * 931 * This function indicates that we are not interested in the events 932 * from this device anymore. Delivery of events may or may not stop, 933 * depending on the number of users still outstanding. 934 */ 935 static inline void hid_hw_close(struct hid_device *hdev) 936 { 937 hdev->ll_driver->close(hdev); 938 } 939 940 /** 941 * hid_hw_power - requests underlying HW to go into given power mode 942 * 943 * @hdev: hid device 944 * @level: requested power level (one of %PM_HINT_* defines) 945 * 946 * This function requests underlying hardware to enter requested power 947 * mode. 948 */ 949 950 static inline int hid_hw_power(struct hid_device *hdev, int level) 951 { 952 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; 953 } 954 955 956 /** 957 * hid_hw_request - send report request to device 958 * 959 * @hdev: hid device 960 * @report: report to send 961 * @reqtype: hid request type 962 */ 963 static inline void hid_hw_request(struct hid_device *hdev, 964 struct hid_report *report, int reqtype) 965 { 966 if (hdev->ll_driver->request) 967 hdev->ll_driver->request(hdev, report, reqtype); 968 } 969 970 /** 971 * hid_hw_idle - send idle request to device 972 * 973 * @hdev: hid device 974 * @report: report to control 975 * @idle: idle state 976 * @reqtype: hid request type 977 */ 978 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, 979 int reqtype) 980 { 981 if (hdev->ll_driver->idle) 982 return hdev->ll_driver->idle(hdev, report, idle, reqtype); 983 984 return 0; 985 } 986 987 /** 988 * hid_hw_wait - wait for buffered io to complete 989 * 990 * @hdev: hid device 991 */ 992 static inline void hid_hw_wait(struct hid_device *hdev) 993 { 994 if (hdev->ll_driver->wait) 995 hdev->ll_driver->wait(hdev); 996 } 997 998 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, 999 int interrupt); 1000 1001 /* HID quirks API */ 1002 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); 1003 int usbhid_quirks_init(char **quirks_param); 1004 void usbhid_quirks_exit(void); 1005 1006 #ifdef CONFIG_HID_PID 1007 int hid_pidff_init(struct hid_device *hid); 1008 #else 1009 #define hid_pidff_init NULL 1010 #endif 1011 1012 #define dbg_hid(format, arg...) \ 1013 do { \ 1014 if (hid_debug) \ 1015 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ 1016 } while (0) 1017 1018 #define hid_printk(level, hid, fmt, arg...) \ 1019 dev_printk(level, &(hid)->dev, fmt, ##arg) 1020 #define hid_emerg(hid, fmt, arg...) \ 1021 dev_emerg(&(hid)->dev, fmt, ##arg) 1022 #define hid_crit(hid, fmt, arg...) \ 1023 dev_crit(&(hid)->dev, fmt, ##arg) 1024 #define hid_alert(hid, fmt, arg...) \ 1025 dev_alert(&(hid)->dev, fmt, ##arg) 1026 #define hid_err(hid, fmt, arg...) \ 1027 dev_err(&(hid)->dev, fmt, ##arg) 1028 #define hid_notice(hid, fmt, arg...) \ 1029 dev_notice(&(hid)->dev, fmt, ##arg) 1030 #define hid_warn(hid, fmt, arg...) \ 1031 dev_warn(&(hid)->dev, fmt, ##arg) 1032 #define hid_info(hid, fmt, arg...) \ 1033 dev_info(&(hid)->dev, fmt, ##arg) 1034 #define hid_dbg(hid, fmt, arg...) \ 1035 dev_dbg(&(hid)->dev, fmt, ##arg) 1036 1037 #endif 1038