Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef __HID_H |
| 2 | #define __HID_H |
| 3 | |
| 4 | /* |
| 5 | * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $ |
| 6 | * |
| 7 | * Copyright (c) 1999 Andreas Gal |
| 8 | * Copyright (c) 2000-2001 Vojtech Pavlik |
Jiri Kosina | b55fd23 | 2007-02-21 19:27:49 +0100 | [diff] [blame] | 9 | * Copyright (c) 2006-2007 Jiri Kosina |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | */ |
| 11 | |
| 12 | /* |
| 13 | * This program is free software; you can redistribute it and/or modify |
| 14 | * it under the terms of the GNU General Public License as published by |
| 15 | * the Free Software Foundation; either version 2 of the License, or |
| 16 | * (at your option) any later version. |
| 17 | * |
| 18 | * This program is distributed in the hope that it will be useful, |
| 19 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | * GNU General Public License for more details. |
| 22 | * |
| 23 | * You should have received a copy of the GNU General Public License |
| 24 | * along with this program; if not, write to the Free Software |
| 25 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 26 | * |
| 27 | * Should you need to contact me, the author, you can do so either by |
| 28 | * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: |
| 29 | * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic |
| 30 | */ |
| 31 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | /* |
| 33 | * USB HID (Human Interface Device) interface class code |
| 34 | */ |
| 35 | |
| 36 | #define USB_INTERFACE_CLASS_HID 3 |
| 37 | |
| 38 | /* |
Alan Stern | 0f28b55 | 2006-05-15 14:49:04 -0400 | [diff] [blame] | 39 | * USB HID interface subclass and protocol codes |
| 40 | */ |
| 41 | |
| 42 | #define USB_INTERFACE_SUBCLASS_BOOT 1 |
| 43 | #define USB_INTERFACE_PROTOCOL_KEYBOARD 1 |
| 44 | #define USB_INTERFACE_PROTOCOL_MOUSE 2 |
| 45 | |
| 46 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | * HID class requests |
| 48 | */ |
| 49 | |
| 50 | #define HID_REQ_GET_REPORT 0x01 |
| 51 | #define HID_REQ_GET_IDLE 0x02 |
| 52 | #define HID_REQ_GET_PROTOCOL 0x03 |
| 53 | #define HID_REQ_SET_REPORT 0x09 |
| 54 | #define HID_REQ_SET_IDLE 0x0A |
| 55 | #define HID_REQ_SET_PROTOCOL 0x0B |
| 56 | |
| 57 | /* |
| 58 | * HID class descriptor types |
| 59 | */ |
| 60 | |
| 61 | #define HID_DT_HID (USB_TYPE_CLASS | 0x01) |
| 62 | #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02) |
| 63 | #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03) |
| 64 | |
Jiri Kosina | 57d292b | 2007-10-15 15:17:41 +0200 | [diff] [blame] | 65 | #define HID_MAX_DESCRIPTOR_SIZE 4096 |
| 66 | |
| 67 | #ifdef __KERNEL__ |
| 68 | |
| 69 | #include <linux/types.h> |
| 70 | #include <linux/slab.h> |
| 71 | #include <linux/list.h> |
| 72 | #include <linux/timer.h> |
| 73 | #include <linux/workqueue.h> |
| 74 | #include <linux/input.h> |
| 75 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 76 | /* |
| 77 | * We parse each description item into this structure. Short items data |
| 78 | * values are expanded to 32-bit signed int, long items contain a pointer |
| 79 | * into the data area. |
| 80 | */ |
| 81 | |
| 82 | struct hid_item { |
| 83 | unsigned format; |
| 84 | __u8 size; |
| 85 | __u8 type; |
| 86 | __u8 tag; |
| 87 | union { |
| 88 | __u8 u8; |
| 89 | __s8 s8; |
| 90 | __u16 u16; |
| 91 | __s16 s16; |
| 92 | __u32 u32; |
| 93 | __s32 s32; |
| 94 | __u8 *longdata; |
| 95 | } data; |
| 96 | }; |
| 97 | |
| 98 | /* |
| 99 | * HID report item format |
| 100 | */ |
| 101 | |
| 102 | #define HID_ITEM_FORMAT_SHORT 0 |
| 103 | #define HID_ITEM_FORMAT_LONG 1 |
| 104 | |
| 105 | /* |
| 106 | * Special tag indicating long items |
| 107 | */ |
| 108 | |
| 109 | #define HID_ITEM_TAG_LONG 15 |
| 110 | |
| 111 | /* |
| 112 | * HID report descriptor item type (prefix bit 2,3) |
| 113 | */ |
| 114 | |
| 115 | #define HID_ITEM_TYPE_MAIN 0 |
| 116 | #define HID_ITEM_TYPE_GLOBAL 1 |
| 117 | #define HID_ITEM_TYPE_LOCAL 2 |
| 118 | #define HID_ITEM_TYPE_RESERVED 3 |
| 119 | |
| 120 | /* |
| 121 | * HID report descriptor main item tags |
| 122 | */ |
| 123 | |
| 124 | #define HID_MAIN_ITEM_TAG_INPUT 8 |
| 125 | #define HID_MAIN_ITEM_TAG_OUTPUT 9 |
| 126 | #define HID_MAIN_ITEM_TAG_FEATURE 11 |
| 127 | #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10 |
| 128 | #define HID_MAIN_ITEM_TAG_END_COLLECTION 12 |
| 129 | |
| 130 | /* |
| 131 | * HID report descriptor main item contents |
| 132 | */ |
| 133 | |
| 134 | #define HID_MAIN_ITEM_CONSTANT 0x001 |
| 135 | #define HID_MAIN_ITEM_VARIABLE 0x002 |
| 136 | #define HID_MAIN_ITEM_RELATIVE 0x004 |
Dmitry Torokhov | 05f091ab | 2005-05-29 02:29:01 -0500 | [diff] [blame] | 137 | #define HID_MAIN_ITEM_WRAP 0x008 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | #define HID_MAIN_ITEM_NONLINEAR 0x010 |
| 139 | #define HID_MAIN_ITEM_NO_PREFERRED 0x020 |
| 140 | #define HID_MAIN_ITEM_NULL_STATE 0x040 |
| 141 | #define HID_MAIN_ITEM_VOLATILE 0x080 |
| 142 | #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 |
| 143 | |
| 144 | /* |
| 145 | * HID report descriptor collection item types |
| 146 | */ |
| 147 | |
| 148 | #define HID_COLLECTION_PHYSICAL 0 |
| 149 | #define HID_COLLECTION_APPLICATION 1 |
| 150 | #define HID_COLLECTION_LOGICAL 2 |
| 151 | |
| 152 | /* |
| 153 | * HID report descriptor global item tags |
| 154 | */ |
| 155 | |
| 156 | #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0 |
| 157 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1 |
| 158 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2 |
| 159 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3 |
| 160 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4 |
| 161 | #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5 |
| 162 | #define HID_GLOBAL_ITEM_TAG_UNIT 6 |
| 163 | #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7 |
| 164 | #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8 |
| 165 | #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9 |
| 166 | #define HID_GLOBAL_ITEM_TAG_PUSH 10 |
| 167 | #define HID_GLOBAL_ITEM_TAG_POP 11 |
| 168 | |
| 169 | /* |
| 170 | * HID report descriptor local item tags |
| 171 | */ |
| 172 | |
| 173 | #define HID_LOCAL_ITEM_TAG_USAGE 0 |
| 174 | #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1 |
| 175 | #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2 |
| 176 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3 |
| 177 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4 |
| 178 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5 |
| 179 | #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7 |
| 180 | #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8 |
| 181 | #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9 |
| 182 | #define HID_LOCAL_ITEM_TAG_DELIMITER 10 |
| 183 | |
| 184 | /* |
| 185 | * HID usage tables |
| 186 | */ |
| 187 | |
| 188 | #define HID_USAGE_PAGE 0xffff0000 |
| 189 | |
| 190 | #define HID_UP_UNDEFINED 0x00000000 |
Dmitry Torokhov | 05f091ab | 2005-05-29 02:29:01 -0500 | [diff] [blame] | 191 | #define HID_UP_GENDESK 0x00010000 |
Vojtech Pavlik | 0aebfda | 2005-09-05 00:07:59 -0500 | [diff] [blame] | 192 | #define HID_UP_SIMULATION 0x00020000 |
Dmitry Torokhov | 05f091ab | 2005-05-29 02:29:01 -0500 | [diff] [blame] | 193 | #define HID_UP_KEYBOARD 0x00070000 |
| 194 | #define HID_UP_LED 0x00080000 |
| 195 | #define HID_UP_BUTTON 0x00090000 |
| 196 | #define HID_UP_ORDINAL 0x000a0000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | #define HID_UP_CONSUMER 0x000c0000 |
Dmitry Torokhov | 05f091ab | 2005-05-29 02:29:01 -0500 | [diff] [blame] | 198 | #define HID_UP_DIGITIZER 0x000d0000 |
| 199 | #define HID_UP_PID 0x000f0000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 200 | #define HID_UP_HPVENDOR 0xff7f0000 |
| 201 | #define HID_UP_MSVENDOR 0xff000000 |
Stelian Pop | e875ce3 | 2005-09-05 01:57:33 -0500 | [diff] [blame] | 202 | #define HID_UP_CUSTOM 0x00ff0000 |
| 203 | #define HID_UP_LOGIVENDOR 0xffbc0000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 204 | |
| 205 | #define HID_USAGE 0x0000ffff |
| 206 | |
| 207 | #define HID_GD_POINTER 0x00010001 |
| 208 | #define HID_GD_MOUSE 0x00010002 |
| 209 | #define HID_GD_JOYSTICK 0x00010004 |
| 210 | #define HID_GD_GAMEPAD 0x00010005 |
| 211 | #define HID_GD_KEYBOARD 0x00010006 |
| 212 | #define HID_GD_KEYPAD 0x00010007 |
| 213 | #define HID_GD_MULTIAXIS 0x00010008 |
| 214 | #define HID_GD_X 0x00010030 |
| 215 | #define HID_GD_Y 0x00010031 |
| 216 | #define HID_GD_Z 0x00010032 |
| 217 | #define HID_GD_RX 0x00010033 |
| 218 | #define HID_GD_RY 0x00010034 |
| 219 | #define HID_GD_RZ 0x00010035 |
| 220 | #define HID_GD_SLIDER 0x00010036 |
| 221 | #define HID_GD_DIAL 0x00010037 |
| 222 | #define HID_GD_WHEEL 0x00010038 |
| 223 | #define HID_GD_HATSWITCH 0x00010039 |
| 224 | #define HID_GD_BUFFER 0x0001003a |
| 225 | #define HID_GD_BYTECOUNT 0x0001003b |
| 226 | #define HID_GD_MOTION 0x0001003c |
| 227 | #define HID_GD_START 0x0001003d |
| 228 | #define HID_GD_SELECT 0x0001003e |
| 229 | #define HID_GD_VX 0x00010040 |
| 230 | #define HID_GD_VY 0x00010041 |
| 231 | #define HID_GD_VZ 0x00010042 |
| 232 | #define HID_GD_VBRX 0x00010043 |
| 233 | #define HID_GD_VBRY 0x00010044 |
| 234 | #define HID_GD_VBRZ 0x00010045 |
| 235 | #define HID_GD_VNO 0x00010046 |
| 236 | #define HID_GD_FEATURE 0x00010047 |
| 237 | #define HID_GD_UP 0x00010090 |
| 238 | #define HID_GD_DOWN 0x00010091 |
| 239 | #define HID_GD_RIGHT 0x00010092 |
| 240 | #define HID_GD_LEFT 0x00010093 |
| 241 | |
| 242 | /* |
| 243 | * HID report types --- Ouch! HID spec says 1 2 3! |
| 244 | */ |
| 245 | |
| 246 | #define HID_INPUT_REPORT 0 |
| 247 | #define HID_OUTPUT_REPORT 1 |
| 248 | #define HID_FEATURE_REPORT 2 |
| 249 | |
| 250 | /* |
| 251 | * HID device quirks. |
| 252 | */ |
| 253 | |
Paul Walmsley | 876b927 | 2007-04-19 14:56:12 +0200 | [diff] [blame] | 254 | /* |
| 255 | * Increase this if you need to configure more HID quirks at module load time |
| 256 | */ |
| 257 | #define MAX_USBHID_BOOT_QUIRKS 4 |
| 258 | |
Michael Hanselmann | eab9edd | 2006-01-14 10:08:06 -0500 | [diff] [blame] | 259 | #define HID_QUIRK_INVERT 0x00000001 |
| 260 | #define HID_QUIRK_NOTOUCH 0x00000002 |
| 261 | #define HID_QUIRK_IGNORE 0x00000004 |
| 262 | #define HID_QUIRK_NOGET 0x00000008 |
| 263 | #define HID_QUIRK_HIDDEV 0x00000010 |
| 264 | #define HID_QUIRK_BADPAD 0x00000020 |
| 265 | #define HID_QUIRK_MULTI_INPUT 0x00000040 |
| 266 | #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080 |
| 267 | #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100 |
| 268 | #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200 |
Bart Massey | a82e49b | 2006-05-08 14:40:13 -0700 | [diff] [blame] | 269 | #define HID_QUIRK_MIGHTYMOUSE 0x00000400 |
Jiri Kosina | ea9a4a8 | 2007-06-19 14:09:14 +0200 | [diff] [blame] | 270 | #define HID_QUIRK_POWERBOOK_HAS_FN 0x00000800 |
| 271 | #define HID_QUIRK_POWERBOOK_FN_ON 0x00001000 |
| 272 | #define HID_QUIRK_INVERT_HWHEEL 0x00002000 |
| 273 | #define HID_QUIRK_POWERBOOK_ISO_KEYBOARD 0x00004000 |
| 274 | #define HID_QUIRK_BAD_RELATIVE_KEYS 0x00008000 |
| 275 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 |
| 276 | #define HID_QUIRK_IGNORE_MOUSE 0x00020000 |
| 277 | #define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000 |
| 278 | #define HID_QUIRK_DUPLICATE_USAGES 0x00080000 |
| 279 | #define HID_QUIRK_RESET_LEDS 0x00100000 |
| 280 | #define HID_QUIRK_HIDINPUT 0x00200000 |
Ryo Dairiki | 5f9c464 | 2007-06-25 10:31:12 +0200 | [diff] [blame] | 281 | #define HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL 0x00400000 |
| 282 | #define HID_QUIRK_LOGITECH_EXPANDED_KEYMAP 0x00800000 |
Stelian Pop | 0ce91cf | 2007-09-11 23:34:55 +0200 | [diff] [blame] | 283 | #define HID_QUIRK_IGNORE_HIDINPUT 0x01000000 |
Jiri Kosina | ea9a4a8 | 2007-06-19 14:09:14 +0200 | [diff] [blame] | 284 | |
| 285 | /* |
| 286 | * Separate quirks for runtime report descriptor fixup |
| 287 | */ |
| 288 | |
| 289 | #define HID_QUIRK_RDESC_CYMOTION 0x00000001 |
| 290 | #define HID_QUIRK_RDESC_LOGITECH 0x00000002 |
| 291 | #define HID_QUIRK_RDESC_SWAPPED_MIN_MAX 0x00000004 |
| 292 | #define HID_QUIRK_RDESC_PETALYNX 0x00000008 |
Tomoya Adachi | 08f0617 | 2007-10-03 23:27:49 +0200 | [diff] [blame] | 293 | #define HID_QUIRK_RDESC_MACBOOK_JIS 0x00000010 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 294 | |
| 295 | /* |
| 296 | * This is the global environment of the parser. This information is |
| 297 | * persistent for main-items. The global environment can be saved and |
| 298 | * restored with PUSH/POP statements. |
| 299 | */ |
| 300 | |
| 301 | struct hid_global { |
| 302 | unsigned usage_page; |
| 303 | __s32 logical_minimum; |
| 304 | __s32 logical_maximum; |
| 305 | __s32 physical_minimum; |
| 306 | __s32 physical_maximum; |
| 307 | __s32 unit_exponent; |
| 308 | unsigned unit; |
| 309 | unsigned report_id; |
| 310 | unsigned report_size; |
| 311 | unsigned report_count; |
| 312 | }; |
| 313 | |
| 314 | /* |
| 315 | * This is the local environment. It is persistent up the next main-item. |
| 316 | */ |
| 317 | |
Jiri Kosina | b55fd23 | 2007-02-21 19:27:49 +0100 | [diff] [blame] | 318 | #define HID_MAX_USAGES 8192 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 319 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
| 320 | |
| 321 | struct hid_local { |
| 322 | unsigned usage[HID_MAX_USAGES]; /* usage array */ |
| 323 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ |
| 324 | unsigned usage_index; |
| 325 | unsigned usage_minimum; |
| 326 | unsigned delimiter_depth; |
| 327 | unsigned delimiter_branch; |
| 328 | }; |
| 329 | |
| 330 | /* |
| 331 | * This is the collection stack. We climb up the stack to determine |
| 332 | * application and function of each field. |
| 333 | */ |
| 334 | |
| 335 | struct hid_collection { |
| 336 | unsigned type; |
| 337 | unsigned usage; |
| 338 | unsigned level; |
| 339 | }; |
| 340 | |
| 341 | struct hid_usage { |
| 342 | unsigned hid; /* hid usage code */ |
| 343 | unsigned collection_index; /* index into collection array */ |
| 344 | /* hidinput data */ |
| 345 | __u16 code; /* input driver code */ |
| 346 | __u8 type; /* input driver type */ |
| 347 | __s8 hat_min; /* hat switch fun */ |
| 348 | __s8 hat_max; /* ditto */ |
| 349 | __s8 hat_dir; /* ditto */ |
| 350 | }; |
| 351 | |
| 352 | struct hid_input; |
| 353 | |
| 354 | struct hid_field { |
| 355 | unsigned physical; /* physical usage for this field */ |
| 356 | unsigned logical; /* logical usage for this field */ |
| 357 | unsigned application; /* application usage for this field */ |
| 358 | struct hid_usage *usage; /* usage table for this function */ |
| 359 | unsigned maxusage; /* maximum usage index */ |
| 360 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ |
| 361 | unsigned report_offset; /* bit offset in the report */ |
| 362 | unsigned report_size; /* size of this field in the report */ |
| 363 | unsigned report_count; /* number of this field in the report */ |
| 364 | unsigned report_type; /* (input,output,feature) */ |
| 365 | __s32 *value; /* last known value(s) */ |
| 366 | __s32 logical_minimum; |
| 367 | __s32 logical_maximum; |
| 368 | __s32 physical_minimum; |
| 369 | __s32 physical_maximum; |
| 370 | __s32 unit_exponent; |
| 371 | unsigned unit; |
| 372 | struct hid_report *report; /* associated report */ |
| 373 | unsigned index; /* index into report->field[] */ |
| 374 | /* hidinput data */ |
| 375 | struct hid_input *hidinput; /* associated input structure */ |
| 376 | __u16 dpad; /* dpad input code */ |
| 377 | }; |
| 378 | |
| 379 | #define HID_MAX_FIELDS 64 |
| 380 | |
| 381 | struct hid_report { |
| 382 | struct list_head list; |
| 383 | unsigned id; /* id of this report */ |
| 384 | unsigned type; /* report type */ |
| 385 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ |
| 386 | unsigned maxfield; /* maximum valid field index */ |
| 387 | unsigned size; /* size of the report (bits) */ |
| 388 | struct hid_device *device; /* associated device */ |
| 389 | }; |
| 390 | |
| 391 | struct hid_report_enum { |
| 392 | unsigned numbered; |
| 393 | struct list_head report_list; |
| 394 | struct hid_report *report_id_hash[256]; |
| 395 | }; |
| 396 | |
| 397 | #define HID_REPORT_TYPES 3 |
| 398 | |
Michael Haboustak | bf0964d | 2005-09-05 00:12:01 -0500 | [diff] [blame] | 399 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
| 400 | #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 401 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
| 402 | #define HID_OUTPUT_FIFO_SIZE 64 |
| 403 | |
| 404 | struct hid_control_fifo { |
| 405 | unsigned char dir; |
| 406 | struct hid_report *report; |
| 407 | }; |
| 408 | |
| 409 | #define HID_CLAIMED_INPUT 1 |
| 410 | #define HID_CLAIMED_HIDDEV 2 |
Jiri Kosina | 86166b7 | 2007-05-14 09:57:40 +0200 | [diff] [blame] | 411 | #define HID_CLAIMED_HIDRAW 4 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 412 | |
| 413 | #define HID_CTRL_RUNNING 1 |
| 414 | #define HID_OUT_RUNNING 2 |
Alan Stern | aef4e26 | 2006-01-31 12:58:38 -0500 | [diff] [blame] | 415 | #define HID_IN_RUNNING 3 |
| 416 | #define HID_RESET_PENDING 4 |
| 417 | #define HID_SUSPENDED 5 |
Alan Stern | 6d8fc4d | 2006-10-18 12:35:24 -0400 | [diff] [blame] | 418 | #define HID_CLEAR_HALT 6 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 419 | |
| 420 | struct hid_input { |
| 421 | struct list_head list; |
| 422 | struct hid_report *report; |
Dmitry Torokhov | c5b7c7c | 2005-09-15 02:01:47 -0500 | [diff] [blame] | 423 | struct input_dev *input; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | }; |
| 425 | |
| 426 | struct hid_device { /* device report descriptor */ |
| 427 | __u8 *rdesc; |
| 428 | unsigned rsize; |
| 429 | struct hid_collection *collection; /* List of HID collections */ |
| 430 | unsigned collection_size; /* Number of allocated hid_collections */ |
| 431 | unsigned maxcollection; /* Number of parsed collections */ |
| 432 | unsigned maxapplication; /* Number of applications */ |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 433 | unsigned short bus; /* BUS ID */ |
| 434 | unsigned short vendor; /* Vendor ID */ |
| 435 | unsigned short product; /* Product ID */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 436 | unsigned version; /* HID version */ |
| 437 | unsigned country; /* HID country */ |
| 438 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; |
| 439 | |
Jiri Kosina | 4916b3a | 2006-12-08 18:41:03 +0100 | [diff] [blame] | 440 | struct device *dev; /* device */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 441 | |
Dmitry Torokhov | 05f091ab | 2005-05-29 02:29:01 -0500 | [diff] [blame] | 442 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 443 | unsigned quirks; /* Various quirks the device can pull on us */ |
| 444 | |
| 445 | struct list_head inputs; /* The list of inputs */ |
| 446 | void *hiddev; /* The hiddev structure */ |
Jiri Kosina | 86166b7 | 2007-05-14 09:57:40 +0200 | [diff] [blame] | 447 | void *hidraw; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 448 | int minor; /* Hiddev minor number */ |
| 449 | |
| 450 | wait_queue_head_t wait; /* For sleeping */ |
| 451 | |
| 452 | int open; /* is the device open by anyone? */ |
| 453 | char name[128]; /* Device name */ |
| 454 | char phys[64]; /* Device physical location */ |
| 455 | char uniq[64]; /* Device unique identifier (serial #) */ |
| 456 | |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 457 | void *driver_data; |
| 458 | |
| 459 | /* device-specific function pointers */ |
| 460 | int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int); |
Jiri Kosina | 7c37914 | 2007-01-24 11:54:19 +0100 | [diff] [blame] | 461 | int (*hid_open) (struct hid_device *); |
| 462 | void (*hid_close) (struct hid_device *); |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 463 | |
Jiri Kosina | aa938f7 | 2006-12-08 18:41:10 +0100 | [diff] [blame] | 464 | /* hiddev event handler */ |
| 465 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
| 466 | struct hid_usage *, __s32); |
Jiri Kosina | aa8de2f | 2006-12-08 18:41:17 +0100 | [diff] [blame] | 467 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
Jiri Kosina | 86166b7 | 2007-05-14 09:57:40 +0200 | [diff] [blame] | 468 | |
| 469 | /* handler for raw output data, used by hidraw */ |
| 470 | int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t); |
Michael Hanselmann | eab9edd | 2006-01-14 10:08:06 -0500 | [diff] [blame] | 471 | #ifdef CONFIG_USB_HIDINPUT_POWERBOOK |
Jiri Slaby | 7b19ada | 2007-10-18 23:40:32 -0700 | [diff] [blame] | 472 | unsigned long pb_pressed_fn[BITS_TO_LONGS(KEY_CNT)]; |
| 473 | unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)]; |
Michael Hanselmann | eab9edd | 2006-01-14 10:08:06 -0500 | [diff] [blame] | 474 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 475 | }; |
| 476 | |
| 477 | #define HID_GLOBAL_STACK_SIZE 4 |
| 478 | #define HID_COLLECTION_STACK_SIZE 4 |
| 479 | |
| 480 | struct hid_parser { |
| 481 | struct hid_global global; |
| 482 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; |
| 483 | unsigned global_stack_ptr; |
| 484 | struct hid_local local; |
| 485 | unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; |
| 486 | unsigned collection_stack_ptr; |
| 487 | struct hid_device *device; |
| 488 | }; |
| 489 | |
| 490 | struct hid_class_descriptor { |
| 491 | __u8 bDescriptorType; |
| 492 | __u16 wDescriptorLength; |
| 493 | } __attribute__ ((packed)); |
| 494 | |
| 495 | struct hid_descriptor { |
| 496 | __u8 bLength; |
| 497 | __u8 bDescriptorType; |
| 498 | __u16 bcdHID; |
| 499 | __u8 bCountryCode; |
| 500 | __u8 bNumDescriptors; |
| 501 | |
| 502 | struct hid_class_descriptor desc[1]; |
| 503 | } __attribute__ ((packed)); |
| 504 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 505 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
| 506 | /* We ignore a few input applications that are not widely used */ |
| 507 | #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001)) |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 508 | |
| 509 | /* HID core API */ |
Jiri Kosina | 58037eb | 2007-05-30 15:07:13 +0200 | [diff] [blame] | 510 | |
| 511 | #ifdef CONFIG_HID_DEBUG |
| 512 | extern int hid_debug; |
| 513 | #endif |
| 514 | |
David Howells | 7d12e78 | 2006-10-05 14:55:46 +0100 | [diff] [blame] | 515 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 516 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
| 517 | extern int hidinput_connect(struct hid_device *); |
| 518 | extern void hidinput_disconnect(struct hid_device *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 519 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 520 | int hid_set_field(struct hid_field *, unsigned, __s32); |
Jiri Kosina | aa8de2f | 2006-12-08 18:41:17 +0100 | [diff] [blame] | 521 | int hid_input_report(struct hid_device *, int type, u8 *, int, int); |
Jiri Kosina | dde5845 | 2006-12-08 18:40:44 +0100 | [diff] [blame] | 522 | int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); |
| 523 | void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt); |
| 524 | void hid_output_report(struct hid_report *report, __u8 *data); |
| 525 | void hid_free_device(struct hid_device *device); |
| 526 | struct hid_device *hid_parse_report(__u8 *start, unsigned size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 527 | |
Paul Walmsley | 876b927 | 2007-04-19 14:56:12 +0200 | [diff] [blame] | 528 | /* HID quirks API */ |
Paul Walmsley | 2eb5dc3 | 2007-04-19 13:27:04 +0200 | [diff] [blame] | 529 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); |
Paul Walmsley | 8cef908 | 2007-04-19 14:37:44 +0200 | [diff] [blame] | 530 | int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct, const u32 quirks); |
Paul Walmsley | 876b927 | 2007-04-19 14:56:12 +0200 | [diff] [blame] | 531 | int usbhid_quirks_init(char **quirks_param); |
| 532 | void usbhid_quirks_exit(void); |
Jiri Kosina | ea9a4a8 | 2007-06-19 14:09:14 +0200 | [diff] [blame] | 533 | void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **); |
Paul Walmsley | 2eb5dc3 | 2007-04-19 13:27:04 +0200 | [diff] [blame] | 534 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 535 | #ifdef CONFIG_HID_FF |
| 536 | int hid_ff_init(struct hid_device *hid); |
Anssi Hannula | 224ee88 | 2006-07-19 01:40:47 -0400 | [diff] [blame] | 537 | |
| 538 | int hid_lgff_init(struct hid_device *hid); |
Anssi Hannula | 20eb127 | 2007-01-11 16:51:18 +0200 | [diff] [blame] | 539 | int hid_plff_init(struct hid_device *hid); |
Anssi Hannula | 224ee88 | 2006-07-19 01:40:47 -0400 | [diff] [blame] | 540 | int hid_tmff_init(struct hid_device *hid); |
Anssi Hannula | bb3caf7 | 2006-07-19 01:44:17 -0400 | [diff] [blame] | 541 | int hid_zpff_init(struct hid_device *hid); |
Anssi Hannula | 224ee88 | 2006-07-19 01:40:47 -0400 | [diff] [blame] | 542 | #ifdef CONFIG_HID_PID |
| 543 | int hid_pidff_init(struct hid_device *hid); |
| 544 | #else |
| 545 | static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; } |
| 546 | #endif |
| 547 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 548 | #else |
| 549 | static inline int hid_ff_init(struct hid_device *hid) { return -1; } |
| 550 | #endif |
Jiri Kosina | 58037eb | 2007-05-30 15:07:13 +0200 | [diff] [blame] | 551 | |
| 552 | #ifdef CONFIG_HID_DEBUG |
| 553 | #define dbg_hid(format, arg...) if (hid_debug) \ |
| 554 | printk(KERN_DEBUG "%s: " format ,\ |
| 555 | __FILE__ , ## arg) |
| 556 | #define dbg_hid_line(format, arg...) if (hid_debug) \ |
| 557 | printk(format, ## arg) |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 558 | #else |
Jiri Kosina | 58037eb | 2007-05-30 15:07:13 +0200 | [diff] [blame] | 559 | #define dbg_hid(format, arg...) do {} while (0) |
| 560 | #define dbg_hid_line dbg_hid |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 561 | #endif |
| 562 | |
Jiri Kosina | 58037eb | 2007-05-30 15:07:13 +0200 | [diff] [blame] | 563 | #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \ |
Jiri Kosina | 229695e | 2006-12-08 18:40:53 +0100 | [diff] [blame] | 564 | __FILE__ , ## arg) |
Jiri Kosina | dde5845 | 2006-12-08 18:40:44 +0100 | [diff] [blame] | 565 | #endif |
Jiri Kosina | 57d292b | 2007-10-15 15:17:41 +0200 | [diff] [blame] | 566 | #endif |
Anssi Hannula | 224ee88 | 2006-07-19 01:40:47 -0400 | [diff] [blame] | 567 | |