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