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 /* 256 * HID connect requests 257 */ 258 259 #define HID_CONNECT_HIDINPUT 0x01 260 #define HID_CONNECT_HIDINPUT_FORCE 0x02 261 #define HID_CONNECT_HIDRAW 0x04 262 #define HID_CONNECT_HIDDEV 0x08 263 #define HID_CONNECT_HIDDEV_FORCE 0x10 264 #define HID_CONNECT_FF 0x20 265 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ 266 HID_CONNECT_HIDDEV|HID_CONNECT_FF) 267 268 /* 269 * HID device quirks. 270 */ 271 272 /* 273 * Increase this if you need to configure more HID quirks at module load time 274 */ 275 #define MAX_USBHID_BOOT_QUIRKS 4 276 277 #define HID_QUIRK_INVERT 0x00000001 278 #define HID_QUIRK_NOTOUCH 0x00000002 279 #define HID_QUIRK_IGNORE 0x00000004 280 #define HID_QUIRK_NOGET 0x00000008 281 #define HID_QUIRK_HIDDEV_FORCE 0x00000010 282 #define HID_QUIRK_BADPAD 0x00000020 283 #define HID_QUIRK_MULTI_INPUT 0x00000040 284 #define HID_QUIRK_HIDINPUT_FORCE 0x00000080 285 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 286 #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000 287 #define HID_QUIRK_NO_INIT_REPORTS 0x20000000 288 #define HID_QUIRK_NO_IGNORE 0x40000000 289 #define HID_QUIRK_NO_INPUT_SYNC 0x80000000 290 291 /* 292 * HID device groups 293 */ 294 #define HID_GROUP_GENERIC 0x0001 295 #define HID_GROUP_MULTITOUCH 0x0002 296 #define HID_GROUP_SENSOR_HUB 0x0003 297 298 /* 299 * This is the global environment of the parser. This information is 300 * persistent for main-items. The global environment can be saved and 301 * restored with PUSH/POP statements. 302 */ 303 304 struct hid_global { 305 unsigned usage_page; 306 __s32 logical_minimum; 307 __s32 logical_maximum; 308 __s32 physical_minimum; 309 __s32 physical_maximum; 310 __s32 unit_exponent; 311 unsigned unit; 312 unsigned report_id; 313 unsigned report_size; 314 unsigned report_count; 315 }; 316 317 /* 318 * This is the local environment. It is persistent up the next main-item. 319 */ 320 321 #define HID_MAX_USAGES 12288 322 #define HID_DEFAULT_NUM_COLLECTIONS 16 323 324 struct hid_local { 325 unsigned usage[HID_MAX_USAGES]; /* usage array */ 326 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ 327 unsigned usage_index; 328 unsigned usage_minimum; 329 unsigned delimiter_depth; 330 unsigned delimiter_branch; 331 }; 332 333 /* 334 * This is the collection stack. We climb up the stack to determine 335 * application and function of each field. 336 */ 337 338 struct hid_collection { 339 unsigned type; 340 unsigned usage; 341 unsigned level; 342 }; 343 344 struct hid_usage { 345 unsigned hid; /* hid usage code */ 346 unsigned collection_index; /* index into collection array */ 347 unsigned usage_index; /* index into usage array */ 348 /* hidinput data */ 349 __u16 code; /* input driver code */ 350 __u8 type; /* input driver type */ 351 __s8 hat_min; /* hat switch fun */ 352 __s8 hat_max; /* ditto */ 353 __s8 hat_dir; /* ditto */ 354 }; 355 356 struct hid_input; 357 358 struct hid_field { 359 unsigned physical; /* physical usage for this field */ 360 unsigned logical; /* logical usage for this field */ 361 unsigned application; /* application usage for this field */ 362 struct hid_usage *usage; /* usage table for this function */ 363 unsigned maxusage; /* maximum usage index */ 364 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ 365 unsigned report_offset; /* bit offset in the report */ 366 unsigned report_size; /* size of this field in the report */ 367 unsigned report_count; /* number of this field in the report */ 368 unsigned report_type; /* (input,output,feature) */ 369 __s32 *value; /* last known value(s) */ 370 __s32 logical_minimum; 371 __s32 logical_maximum; 372 __s32 physical_minimum; 373 __s32 physical_maximum; 374 __s32 unit_exponent; 375 unsigned unit; 376 struct hid_report *report; /* associated report */ 377 unsigned index; /* index into report->field[] */ 378 /* hidinput data */ 379 struct hid_input *hidinput; /* associated input structure */ 380 __u16 dpad; /* dpad input code */ 381 }; 382 383 #define HID_MAX_FIELDS 256 384 385 struct hid_report { 386 struct list_head list; 387 unsigned id; /* id of this report */ 388 unsigned type; /* report type */ 389 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ 390 unsigned maxfield; /* maximum valid field index */ 391 unsigned size; /* size of the report (bits) */ 392 struct hid_device *device; /* associated device */ 393 }; 394 395 struct hid_report_enum { 396 unsigned numbered; 397 struct list_head report_list; 398 struct hid_report *report_id_hash[256]; 399 }; 400 401 #define HID_REPORT_TYPES 3 402 403 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ 404 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ 405 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ 406 #define HID_OUTPUT_FIFO_SIZE 64 407 408 struct hid_control_fifo { 409 unsigned char dir; 410 struct hid_report *report; 411 char *raw_report; 412 }; 413 414 struct hid_output_fifo { 415 struct hid_report *report; 416 char *raw_report; 417 }; 418 419 #define HID_CLAIMED_INPUT 1 420 #define HID_CLAIMED_HIDDEV 2 421 #define HID_CLAIMED_HIDRAW 4 422 423 #define HID_STAT_ADDED 1 424 #define HID_STAT_PARSED 2 425 426 struct hid_input { 427 struct list_head list; 428 struct hid_report *report; 429 struct input_dev *input; 430 }; 431 432 enum hid_type { 433 HID_TYPE_OTHER = 0, 434 HID_TYPE_USBMOUSE, 435 HID_TYPE_USBNONE 436 }; 437 438 struct hid_driver; 439 struct hid_ll_driver; 440 441 struct hid_device { /* device report descriptor */ 442 __u8 *dev_rdesc; 443 unsigned dev_rsize; 444 __u8 *rdesc; 445 unsigned rsize; 446 struct hid_collection *collection; /* List of HID collections */ 447 unsigned collection_size; /* Number of allocated hid_collections */ 448 unsigned maxcollection; /* Number of parsed collections */ 449 unsigned maxapplication; /* Number of applications */ 450 __u16 bus; /* BUS ID */ 451 __u16 group; /* Report group */ 452 __u32 vendor; /* Vendor ID */ 453 __u32 product; /* Product ID */ 454 __u32 version; /* HID version */ 455 enum hid_type type; /* device type (mouse, kbd, ...) */ 456 unsigned country; /* HID country */ 457 struct hid_report_enum report_enum[HID_REPORT_TYPES]; 458 459 struct semaphore driver_lock; /* protects the current driver */ 460 struct device dev; /* device */ 461 struct hid_driver *driver; 462 struct hid_ll_driver *ll_driver; 463 464 #ifdef CONFIG_HID_BATTERY_STRENGTH 465 /* 466 * Power supply information for HID devices which report 467 * battery strength. power_supply is registered iff 468 * battery.name is non-NULL. 469 */ 470 struct power_supply battery; 471 __s32 battery_min; 472 __s32 battery_max; 473 __s32 battery_report_type; 474 __s32 battery_report_id; 475 #endif 476 477 unsigned int status; /* see STAT flags above */ 478 unsigned claimed; /* Claimed by hidinput, hiddev? */ 479 unsigned quirks; /* Various quirks the device can pull on us */ 480 481 struct list_head inputs; /* The list of inputs */ 482 void *hiddev; /* The hiddev structure */ 483 void *hidraw; 484 int minor; /* Hiddev minor number */ 485 486 int open; /* is the device open by anyone? */ 487 char name[128]; /* Device name */ 488 char phys[64]; /* Device physical location */ 489 char uniq[64]; /* Device unique identifier (serial #) */ 490 491 void *driver_data; 492 493 /* temporary hid_ff handling (until moved to the drivers) */ 494 int (*ff_init)(struct hid_device *); 495 496 /* hiddev event handler */ 497 int (*hiddev_connect)(struct hid_device *, unsigned int); 498 void (*hiddev_disconnect)(struct hid_device *); 499 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, 500 struct hid_usage *, __s32); 501 void (*hiddev_report_event) (struct hid_device *, struct hid_report *); 502 503 /* handler for raw input (Get_Report) data, used by hidraw */ 504 int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char); 505 506 /* handler for raw output data, used by hidraw */ 507 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char); 508 509 /* debugging support via debugfs */ 510 unsigned short debug; 511 struct dentry *debug_dir; 512 struct dentry *debug_rdesc; 513 struct dentry *debug_events; 514 struct list_head debug_list; 515 wait_queue_head_t debug_wait; 516 }; 517 518 static inline void *hid_get_drvdata(struct hid_device *hdev) 519 { 520 return dev_get_drvdata(&hdev->dev); 521 } 522 523 static inline void hid_set_drvdata(struct hid_device *hdev, void *data) 524 { 525 dev_set_drvdata(&hdev->dev, data); 526 } 527 528 #define HID_GLOBAL_STACK_SIZE 4 529 #define HID_COLLECTION_STACK_SIZE 4 530 531 struct hid_parser { 532 struct hid_global global; 533 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; 534 unsigned global_stack_ptr; 535 struct hid_local local; 536 unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; 537 unsigned collection_stack_ptr; 538 struct hid_device *device; 539 }; 540 541 struct hid_class_descriptor { 542 __u8 bDescriptorType; 543 __le16 wDescriptorLength; 544 } __attribute__ ((packed)); 545 546 struct hid_descriptor { 547 __u8 bLength; 548 __u8 bDescriptorType; 549 __le16 bcdHID; 550 __u8 bCountryCode; 551 __u8 bNumDescriptors; 552 553 struct hid_class_descriptor desc[1]; 554 } __attribute__ ((packed)); 555 556 #define HID_DEVICE(b, g, ven, prod) \ 557 .bus = (b), .group = (g), .vendor = (ven), .product = (prod) 558 #define HID_USB_DEVICE(ven, prod) \ 559 .bus = BUS_USB, .vendor = (ven), .product = (prod) 560 #define HID_BLUETOOTH_DEVICE(ven, prod) \ 561 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) 562 563 #define HID_REPORT_ID(rep) \ 564 .report_type = (rep) 565 #define HID_USAGE_ID(uhid, utype, ucode) \ 566 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) 567 /* we don't want to catch types and codes equal to 0 */ 568 #define HID_TERMINATOR (HID_ANY_ID - 1) 569 570 struct hid_report_id { 571 __u32 report_type; 572 }; 573 struct hid_usage_id { 574 __u32 usage_hid; 575 __u32 usage_type; 576 __u32 usage_code; 577 }; 578 579 /** 580 * struct hid_driver 581 * @name: driver name (e.g. "Footech_bar-wheel") 582 * @id_table: which devices is this driver for (must be non-NULL for probe 583 * to be called) 584 * @dyn_list: list of dynamically added device ids 585 * @dyn_lock: lock protecting @dyn_list 586 * @probe: new device inserted 587 * @remove: device removed (NULL if not a hot-plug capable driver) 588 * @report_table: on which reports to call raw_event (NULL means all) 589 * @raw_event: if report in report_table, this hook is called (NULL means nop) 590 * @usage_table: on which events to call event (NULL means all) 591 * @event: if usage in usage_table, this hook is called (NULL means nop) 592 * @report: this hook is called after parsing a report (NULL means nop) 593 * @report_fixup: called before report descriptor parsing (NULL means nop) 594 * @input_mapping: invoked on input registering before mapping an usage 595 * @input_mapped: invoked on input registering after mapping an usage 596 * @input_configured: invoked just before the device is registered 597 * @feature_mapping: invoked on feature registering 598 * @suspend: invoked on suspend (NULL means nop) 599 * @resume: invoked on resume if device was not reset (NULL means nop) 600 * @reset_resume: invoked on resume if device was reset (NULL means nop) 601 * 602 * raw_event and event should return 0 on no action performed, 1 when no 603 * further processing should be done and negative on error 604 * 605 * input_mapping shall return a negative value to completely ignore this usage 606 * (e.g. doubled or invalid usage), zero to continue with parsing of this 607 * usage by generic code (no special handling needed) or positive to skip 608 * generic parsing (needed special handling which was done in the hook already) 609 * input_mapped shall return negative to inform the layer that this usage 610 * should not be considered for further processing or zero to notify that 611 * no processing was performed and should be done in a generic manner 612 * Both these functions may be NULL which means the same behavior as returning 613 * zero from them. 614 */ 615 struct hid_driver { 616 char *name; 617 const struct hid_device_id *id_table; 618 619 struct list_head dyn_list; 620 spinlock_t dyn_lock; 621 622 int (*probe)(struct hid_device *dev, const struct hid_device_id *id); 623 void (*remove)(struct hid_device *dev); 624 625 const struct hid_report_id *report_table; 626 int (*raw_event)(struct hid_device *hdev, struct hid_report *report, 627 u8 *data, int size); 628 const struct hid_usage_id *usage_table; 629 int (*event)(struct hid_device *hdev, struct hid_field *field, 630 struct hid_usage *usage, __s32 value); 631 void (*report)(struct hid_device *hdev, struct hid_report *report); 632 633 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, 634 unsigned int *size); 635 636 int (*input_mapping)(struct hid_device *hdev, 637 struct hid_input *hidinput, struct hid_field *field, 638 struct hid_usage *usage, unsigned long **bit, int *max); 639 int (*input_mapped)(struct hid_device *hdev, 640 struct hid_input *hidinput, struct hid_field *field, 641 struct hid_usage *usage, unsigned long **bit, int *max); 642 void (*input_configured)(struct hid_device *hdev, 643 struct hid_input *hidinput); 644 void (*feature_mapping)(struct hid_device *hdev, 645 struct hid_field *field, 646 struct hid_usage *usage); 647 #ifdef CONFIG_PM 648 int (*suspend)(struct hid_device *hdev, pm_message_t message); 649 int (*resume)(struct hid_device *hdev); 650 int (*reset_resume)(struct hid_device *hdev); 651 #endif 652 /* private: */ 653 struct device_driver driver; 654 }; 655 656 /** 657 * hid_ll_driver - low level driver callbacks 658 * @start: called on probe to start the device 659 * @stop: called on remove 660 * @open: called by input layer on open 661 * @close: called by input layer on close 662 * @hidinput_input_event: event input event (e.g. ff or leds) 663 * @parse: this method is called only once to parse the device data, 664 * shouldn't allocate anything to not leak memory 665 */ 666 struct hid_ll_driver { 667 int (*start)(struct hid_device *hdev); 668 void (*stop)(struct hid_device *hdev); 669 670 int (*open)(struct hid_device *hdev); 671 void (*close)(struct hid_device *hdev); 672 673 int (*power)(struct hid_device *hdev, int level); 674 675 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type, 676 unsigned int code, int value); 677 678 int (*parse)(struct hid_device *hdev); 679 }; 680 681 #define PM_HINT_FULLON 1<<5 682 #define PM_HINT_NORMAL 1<<1 683 684 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ 685 /* We ignore a few input applications that are not widely used */ 686 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) 687 688 /* HID core API */ 689 690 extern int hid_debug; 691 692 extern bool hid_ignore(struct hid_device *); 693 extern int hid_add_device(struct hid_device *); 694 extern void hid_destroy_device(struct hid_device *); 695 696 extern int __must_check __hid_register_driver(struct hid_driver *, 697 struct module *, const char *mod_name); 698 699 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 700 #define hid_register_driver(driver) \ 701 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 702 703 extern void hid_unregister_driver(struct hid_driver *); 704 705 /** 706 * module_hid_driver() - Helper macro for registering a HID driver 707 * @__hid_driver: hid_driver struct 708 * 709 * Helper macro for HID drivers which do not do anything special in module 710 * init/exit. This eliminates a lot of boilerplate. Each module may only 711 * use this macro once, and calling it replaces module_init() and module_exit() 712 */ 713 #define module_hid_driver(__hid_driver) \ 714 module_driver(__hid_driver, hid_register_driver, \ 715 hid_unregister_driver) 716 717 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); 718 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); 719 extern int hidinput_connect(struct hid_device *hid, unsigned int force); 720 extern void hidinput_disconnect(struct hid_device *); 721 722 int hid_set_field(struct hid_field *, unsigned, __s32); 723 int hid_input_report(struct hid_device *, int type, u8 *, int, int); 724 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); 725 struct hid_field *hidinput_get_led_field(struct hid_device *hid); 726 unsigned int hidinput_count_leds(struct hid_device *hid); 727 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); 728 void hid_output_report(struct hid_report *report, __u8 *data); 729 struct hid_device *hid_allocate_device(void); 730 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); 731 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); 732 int hid_open_report(struct hid_device *device); 733 int hid_check_keys_pressed(struct hid_device *hid); 734 int hid_connect(struct hid_device *hid, unsigned int connect_mask); 735 void hid_disconnect(struct hid_device *hid); 736 const struct hid_device_id *hid_match_id(struct hid_device *hdev, 737 const struct hid_device_id *id); 738 s32 hid_snto32(__u32 value, unsigned n); 739 740 /** 741 * hid_map_usage - map usage input bits 742 * 743 * @hidinput: hidinput which we are interested in 744 * @usage: usage to fill in 745 * @bit: pointer to input->{}bit (out parameter) 746 * @max: maximal valid usage->code to consider later (out parameter) 747 * @type: input event type (EV_KEY, EV_REL, ...) 748 * @c: code which corresponds to this usage and type 749 */ 750 static inline void hid_map_usage(struct hid_input *hidinput, 751 struct hid_usage *usage, unsigned long **bit, int *max, 752 __u8 type, __u16 c) 753 { 754 struct input_dev *input = hidinput->input; 755 756 usage->type = type; 757 usage->code = c; 758 759 switch (type) { 760 case EV_ABS: 761 *bit = input->absbit; 762 *max = ABS_MAX; 763 break; 764 case EV_REL: 765 *bit = input->relbit; 766 *max = REL_MAX; 767 break; 768 case EV_KEY: 769 *bit = input->keybit; 770 *max = KEY_MAX; 771 break; 772 case EV_LED: 773 *bit = input->ledbit; 774 *max = LED_MAX; 775 break; 776 } 777 } 778 779 /** 780 * hid_map_usage_clear - map usage input bits and clear the input bit 781 * 782 * The same as hid_map_usage, except the @c bit is also cleared in supported 783 * bits (@bit). 784 */ 785 static inline void hid_map_usage_clear(struct hid_input *hidinput, 786 struct hid_usage *usage, unsigned long **bit, int *max, 787 __u8 type, __u16 c) 788 { 789 hid_map_usage(hidinput, usage, bit, max, type, c); 790 clear_bit(c, *bit); 791 } 792 793 /** 794 * hid_parse - parse HW reports 795 * 796 * @hdev: hid device 797 * 798 * Call this from probe after you set up the device (if needed). Your 799 * report_fixup will be called (if non-NULL) after reading raw report from 800 * device before passing it to hid layer for real parsing. 801 */ 802 static inline int __must_check hid_parse(struct hid_device *hdev) 803 { 804 return hid_open_report(hdev); 805 } 806 807 /** 808 * hid_hw_start - start underlaying HW 809 * 810 * @hdev: hid device 811 * @connect_mask: which outputs to connect, see HID_CONNECT_* 812 * 813 * Call this in probe function *after* hid_parse. This will setup HW buffers 814 * and start the device (if not deffered to device open). hid_hw_stop must be 815 * called if this was successful. 816 */ 817 static inline int __must_check hid_hw_start(struct hid_device *hdev, 818 unsigned int connect_mask) 819 { 820 int ret = hdev->ll_driver->start(hdev); 821 if (ret || !connect_mask) 822 return ret; 823 ret = hid_connect(hdev, connect_mask); 824 if (ret) 825 hdev->ll_driver->stop(hdev); 826 return ret; 827 } 828 829 /** 830 * hid_hw_stop - stop underlaying HW 831 * 832 * @hdev: hid device 833 * 834 * This is usually called from remove function or from probe when something 835 * failed and hid_hw_start was called already. 836 */ 837 static inline void hid_hw_stop(struct hid_device *hdev) 838 { 839 hid_disconnect(hdev); 840 hdev->ll_driver->stop(hdev); 841 } 842 843 /** 844 * hid_hw_open - signal underlaying HW to start delivering events 845 * 846 * @hdev: hid device 847 * 848 * Tell underlying HW to start delivering events from the device. 849 * This function should be called sometime after successful call 850 * to hid_hiw_start(). 851 */ 852 static inline int __must_check hid_hw_open(struct hid_device *hdev) 853 { 854 return hdev->ll_driver->open(hdev); 855 } 856 857 /** 858 * hid_hw_close - signal underlaying HW to stop delivering events 859 * 860 * @hdev: hid device 861 * 862 * This function indicates that we are not interested in the events 863 * from this device anymore. Delivery of events may or may not stop, 864 * depending on the number of users still outstanding. 865 */ 866 static inline void hid_hw_close(struct hid_device *hdev) 867 { 868 hdev->ll_driver->close(hdev); 869 } 870 871 /** 872 * hid_hw_power - requests underlying HW to go into given power mode 873 * 874 * @hdev: hid device 875 * @level: requested power level (one of %PM_HINT_* defines) 876 * 877 * This function requests underlying hardware to enter requested power 878 * mode. 879 */ 880 881 static inline int hid_hw_power(struct hid_device *hdev, int level) 882 { 883 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; 884 } 885 886 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, 887 int interrupt); 888 889 /* HID quirks API */ 890 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); 891 int usbhid_quirks_init(char **quirks_param); 892 void usbhid_quirks_exit(void); 893 void usbhid_set_leds(struct hid_device *hid); 894 895 #ifdef CONFIG_HID_PID 896 int hid_pidff_init(struct hid_device *hid); 897 #else 898 #define hid_pidff_init NULL 899 #endif 900 901 #define dbg_hid(format, arg...) \ 902 do { \ 903 if (hid_debug) \ 904 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ 905 } while (0) 906 907 #define hid_printk(level, hid, fmt, arg...) \ 908 dev_printk(level, &(hid)->dev, fmt, ##arg) 909 #define hid_emerg(hid, fmt, arg...) \ 910 dev_emerg(&(hid)->dev, fmt, ##arg) 911 #define hid_crit(hid, fmt, arg...) \ 912 dev_crit(&(hid)->dev, fmt, ##arg) 913 #define hid_alert(hid, fmt, arg...) \ 914 dev_alert(&(hid)->dev, fmt, ##arg) 915 #define hid_err(hid, fmt, arg...) \ 916 dev_err(&(hid)->dev, fmt, ##arg) 917 #define hid_notice(hid, fmt, arg...) \ 918 dev_notice(&(hid)->dev, fmt, ##arg) 919 #define hid_warn(hid, fmt, arg...) \ 920 dev_warn(&(hid)->dev, fmt, ##arg) 921 #define hid_info(hid, fmt, arg...) \ 922 dev_info(&(hid)->dev, fmt, ##arg) 923 #define hid_dbg(hid, fmt, arg...) \ 924 dev_dbg(&(hid)->dev, fmt, ##arg) 925 926 #endif 927