5 * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $
7 * Copyright (c) 1999 Andreas Gal
8 * Copyright (c) 2000-2001 Vojtech Pavlik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * Should you need to contact me, the author, you can do so either by
27 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
28 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
31 #include <linux/types.h>
32 #include <linux/slab.h>
33 #include <linux/list.h>
36 * USB HID (Human Interface Device) interface class code
39 #define USB_INTERFACE_CLASS_HID 3
45 #define HID_REQ_GET_REPORT 0x01
46 #define HID_REQ_GET_IDLE 0x02
47 #define HID_REQ_GET_PROTOCOL 0x03
48 #define HID_REQ_SET_REPORT 0x09
49 #define HID_REQ_SET_IDLE 0x0A
50 #define HID_REQ_SET_PROTOCOL 0x0B
53 * HID class descriptor types
56 #define HID_DT_HID (USB_TYPE_CLASS | 0x01)
57 #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
58 #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
61 * We parse each description item into this structure. Short items data
62 * values are expanded to 32-bit signed int, long items contain a pointer
83 * HID report item format
86 #define HID_ITEM_FORMAT_SHORT 0
87 #define HID_ITEM_FORMAT_LONG 1
90 * Special tag indicating long items
93 #define HID_ITEM_TAG_LONG 15
96 * HID report descriptor item type (prefix bit 2,3)
99 #define HID_ITEM_TYPE_MAIN 0
100 #define HID_ITEM_TYPE_GLOBAL 1
101 #define HID_ITEM_TYPE_LOCAL 2
102 #define HID_ITEM_TYPE_RESERVED 3
105 * HID report descriptor main item tags
108 #define HID_MAIN_ITEM_TAG_INPUT 8
109 #define HID_MAIN_ITEM_TAG_OUTPUT 9
110 #define HID_MAIN_ITEM_TAG_FEATURE 11
111 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
112 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
115 * HID report descriptor main item contents
118 #define HID_MAIN_ITEM_CONSTANT 0x001
119 #define HID_MAIN_ITEM_VARIABLE 0x002
120 #define HID_MAIN_ITEM_RELATIVE 0x004
121 #define HID_MAIN_ITEM_WRAP 0x008
122 #define HID_MAIN_ITEM_NONLINEAR 0x010
123 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
124 #define HID_MAIN_ITEM_NULL_STATE 0x040
125 #define HID_MAIN_ITEM_VOLATILE 0x080
126 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
129 * HID report descriptor collection item types
132 #define HID_COLLECTION_PHYSICAL 0
133 #define HID_COLLECTION_APPLICATION 1
134 #define HID_COLLECTION_LOGICAL 2
137 * HID report descriptor global item tags
140 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
141 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
142 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
143 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
144 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
145 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
146 #define HID_GLOBAL_ITEM_TAG_UNIT 6
147 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
148 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
149 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
150 #define HID_GLOBAL_ITEM_TAG_PUSH 10
151 #define HID_GLOBAL_ITEM_TAG_POP 11
154 * HID report descriptor local item tags
157 #define HID_LOCAL_ITEM_TAG_USAGE 0
158 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
159 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
160 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
161 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
162 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
163 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
164 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
165 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
166 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
172 #define HID_USAGE_PAGE 0xffff0000
174 #define HID_UP_UNDEFINED 0x00000000
175 #define HID_UP_GENDESK 0x00010000
176 #define HID_UP_SIMULATION 0x00020000
177 #define HID_UP_KEYBOARD 0x00070000
178 #define HID_UP_LED 0x00080000
179 #define HID_UP_BUTTON 0x00090000
180 #define HID_UP_ORDINAL 0x000a0000
181 #define HID_UP_CONSUMER 0x000c0000
182 #define HID_UP_DIGITIZER 0x000d0000
183 #define HID_UP_PID 0x000f0000
184 #define HID_UP_HPVENDOR 0xff7f0000
185 #define HID_UP_MSVENDOR 0xff000000
186 #define HID_UP_CUSTOM 0x00ff0000
187 #define HID_UP_LOGIVENDOR 0xffbc0000
189 #define HID_USAGE 0x0000ffff
191 #define HID_GD_POINTER 0x00010001
192 #define HID_GD_MOUSE 0x00010002
193 #define HID_GD_JOYSTICK 0x00010004
194 #define HID_GD_GAMEPAD 0x00010005
195 #define HID_GD_KEYBOARD 0x00010006
196 #define HID_GD_KEYPAD 0x00010007
197 #define HID_GD_MULTIAXIS 0x00010008
198 #define HID_GD_X 0x00010030
199 #define HID_GD_Y 0x00010031
200 #define HID_GD_Z 0x00010032
201 #define HID_GD_RX 0x00010033
202 #define HID_GD_RY 0x00010034
203 #define HID_GD_RZ 0x00010035
204 #define HID_GD_SLIDER 0x00010036
205 #define HID_GD_DIAL 0x00010037
206 #define HID_GD_WHEEL 0x00010038
207 #define HID_GD_HATSWITCH 0x00010039
208 #define HID_GD_BUFFER 0x0001003a
209 #define HID_GD_BYTECOUNT 0x0001003b
210 #define HID_GD_MOTION 0x0001003c
211 #define HID_GD_START 0x0001003d
212 #define HID_GD_SELECT 0x0001003e
213 #define HID_GD_VX 0x00010040
214 #define HID_GD_VY 0x00010041
215 #define HID_GD_VZ 0x00010042
216 #define HID_GD_VBRX 0x00010043
217 #define HID_GD_VBRY 0x00010044
218 #define HID_GD_VBRZ 0x00010045
219 #define HID_GD_VNO 0x00010046
220 #define HID_GD_FEATURE 0x00010047
221 #define HID_GD_UP 0x00010090
222 #define HID_GD_DOWN 0x00010091
223 #define HID_GD_RIGHT 0x00010092
224 #define HID_GD_LEFT 0x00010093
227 * HID report types --- Ouch! HID spec says 1 2 3!
230 #define HID_INPUT_REPORT 0
231 #define HID_OUTPUT_REPORT 1
232 #define HID_FEATURE_REPORT 2
238 #define HID_QUIRK_INVERT 0x001
239 #define HID_QUIRK_NOTOUCH 0x002
240 #define HID_QUIRK_IGNORE 0x004
241 #define HID_QUIRK_NOGET 0x008
242 #define HID_QUIRK_HIDDEV 0x010
243 #define HID_QUIRK_BADPAD 0x020
244 #define HID_QUIRK_MULTI_INPUT 0x040
245 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x080
246 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x100
247 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x200
248 #define HID_QUIRK_2WHEEL_POWERMOUSE 0x400
251 * This is the global environment of the parser. This information is
252 * persistent for main-items. The global environment can be saved and
253 * restored with PUSH/POP statements.
258 __s32 logical_minimum
;
259 __s32 logical_maximum
;
260 __s32 physical_minimum
;
261 __s32 physical_maximum
;
265 unsigned report_size
;
266 unsigned report_count
;
270 * This is the local environment. It is persistent up the next main-item.
273 #define HID_MAX_DESCRIPTOR_SIZE 4096
274 #define HID_MAX_USAGES 1024
275 #define HID_DEFAULT_NUM_COLLECTIONS 16
278 unsigned usage
[HID_MAX_USAGES
]; /* usage array */
279 unsigned collection_index
[HID_MAX_USAGES
]; /* collection index array */
280 unsigned usage_index
;
281 unsigned usage_minimum
;
282 unsigned delimiter_depth
;
283 unsigned delimiter_branch
;
287 * This is the collection stack. We climb up the stack to determine
288 * application and function of each field.
291 struct hid_collection
{
298 unsigned hid
; /* hid usage code */
299 unsigned collection_index
; /* index into collection array */
301 __u16 code
; /* input driver code */
302 __u8 type
; /* input driver type */
303 __s8 hat_min
; /* hat switch fun */
304 __s8 hat_max
; /* ditto */
305 __s8 hat_dir
; /* ditto */
311 unsigned physical
; /* physical usage for this field */
312 unsigned logical
; /* logical usage for this field */
313 unsigned application
; /* application usage for this field */
314 struct hid_usage
*usage
; /* usage table for this function */
315 unsigned maxusage
; /* maximum usage index */
316 unsigned flags
; /* main-item flags (i.e. volatile,array,constant) */
317 unsigned report_offset
; /* bit offset in the report */
318 unsigned report_size
; /* size of this field in the report */
319 unsigned report_count
; /* number of this field in the report */
320 unsigned report_type
; /* (input,output,feature) */
321 __s32
*value
; /* last known value(s) */
322 __s32 logical_minimum
;
323 __s32 logical_maximum
;
324 __s32 physical_minimum
;
325 __s32 physical_maximum
;
328 struct hid_report
*report
; /* associated report */
329 unsigned index
; /* index into report->field[] */
331 struct hid_input
*hidinput
; /* associated input structure */
332 __u16 dpad
; /* dpad input code */
335 #define HID_MAX_FIELDS 64
338 struct list_head list
;
339 unsigned id
; /* id of this report */
340 unsigned type
; /* report type */
341 struct hid_field
*field
[HID_MAX_FIELDS
]; /* fields of the report */
342 unsigned maxfield
; /* maximum valid field index */
343 unsigned size
; /* size of the report (bits) */
344 struct hid_device
*device
; /* associated device */
347 struct hid_report_enum
{
349 struct list_head report_list
;
350 struct hid_report
*report_id_hash
[256];
353 #define HID_REPORT_TYPES 3
355 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
356 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
357 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
358 #define HID_OUTPUT_FIFO_SIZE 64
360 struct hid_control_fifo
{
362 struct hid_report
*report
;
365 #define HID_CLAIMED_INPUT 1
366 #define HID_CLAIMED_HIDDEV 2
368 #define HID_CTRL_RUNNING 1
369 #define HID_OUT_RUNNING 2
372 struct list_head list
;
373 struct hid_report
*report
;
374 struct input_dev
*input
;
377 struct hid_device
{ /* device report descriptor */
380 struct hid_collection
*collection
; /* List of HID collections */
381 unsigned collection_size
; /* Number of allocated hid_collections */
382 unsigned maxcollection
; /* Number of parsed collections */
383 unsigned maxapplication
; /* Number of applications */
384 unsigned version
; /* HID version */
385 unsigned country
; /* HID country */
386 struct hid_report_enum report_enum
[HID_REPORT_TYPES
];
388 struct usb_device
*dev
; /* USB device */
389 struct usb_interface
*intf
; /* USB interface */
390 int ifnum
; /* USB interface number */
392 unsigned long iofl
; /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
394 unsigned int bufsize
; /* URB buffer size */
396 struct urb
*urbin
; /* Input URB */
397 char *inbuf
; /* Input buffer */
398 dma_addr_t inbuf_dma
; /* Input buffer dma */
400 struct urb
*urbctrl
; /* Control URB */
401 struct usb_ctrlrequest
*cr
; /* Control request struct */
402 dma_addr_t cr_dma
; /* Control request struct dma */
403 struct hid_control_fifo ctrl
[HID_CONTROL_FIFO_SIZE
]; /* Control fifo */
404 unsigned char ctrlhead
, ctrltail
; /* Control fifo head & tail */
405 char *ctrlbuf
; /* Control buffer */
406 dma_addr_t ctrlbuf_dma
; /* Control buffer dma */
407 spinlock_t ctrllock
; /* Control fifo spinlock */
409 struct urb
*urbout
; /* Output URB */
410 struct hid_report
*out
[HID_CONTROL_FIFO_SIZE
]; /* Output pipe fifo */
411 unsigned char outhead
, outtail
; /* Output pipe fifo head & tail */
412 char *outbuf
; /* Output buffer */
413 dma_addr_t outbuf_dma
; /* Output buffer dma */
414 spinlock_t outlock
; /* Output fifo spinlock */
416 unsigned claimed
; /* Claimed by hidinput, hiddev? */
417 unsigned quirks
; /* Various quirks the device can pull on us */
419 struct list_head inputs
; /* The list of inputs */
420 void *hiddev
; /* The hiddev structure */
421 int minor
; /* Hiddev minor number */
423 wait_queue_head_t wait
; /* For sleeping */
425 int open
; /* is the device open by anyone? */
426 char name
[128]; /* Device name */
427 char phys
[64]; /* Device physical location */
428 char uniq
[64]; /* Device unique identifier (serial #) */
430 void *ff_private
; /* Private data for the force-feedback driver */
431 void (*ff_exit
)(struct hid_device
*); /* Called by hid_exit_ff(hid) */
432 int (*ff_event
)(struct hid_device
*hid
, struct input_dev
*input
,
433 unsigned int type
, unsigned int code
, int value
);
436 #define HID_GLOBAL_STACK_SIZE 4
437 #define HID_COLLECTION_STACK_SIZE 4
440 struct hid_global global
;
441 struct hid_global global_stack
[HID_GLOBAL_STACK_SIZE
];
442 unsigned global_stack_ptr
;
443 struct hid_local local
;
444 unsigned collection_stack
[HID_COLLECTION_STACK_SIZE
];
445 unsigned collection_stack_ptr
;
446 struct hid_device
*device
;
449 struct hid_class_descriptor
{
450 __u8 bDescriptorType
;
451 __u16 wDescriptorLength
;
452 } __attribute__ ((packed
));
454 struct hid_descriptor
{
456 __u8 bDescriptorType
;
459 __u8 bNumDescriptors
;
461 struct hid_class_descriptor desc
[1];
462 } __attribute__ ((packed
));
465 #include "hid-debug.h"
467 #define hid_dump_input(a,b) do { } while (0)
468 #define hid_dump_device(c) do { } while (0)
469 #define hid_dump_field(a,b) do { } while (0)
470 #define resolv_usage(a) do { } while (0)
471 #define resolv_event(a,b) do { } while (0)
476 #ifdef CONFIG_USB_HIDINPUT
477 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
478 /* We ignore a few input applications that are not widely used */
479 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
480 extern void hidinput_hid_event(struct hid_device
*, struct hid_field
*, struct hid_usage
*, __s32
, struct pt_regs
*regs
);
481 extern void hidinput_report_event(struct hid_device
*hid
, struct hid_report
*report
);
482 extern int hidinput_connect(struct hid_device
*);
483 extern void hidinput_disconnect(struct hid_device
*);
485 #define IS_INPUT_APPLICATION(a) (0)
486 static inline void hidinput_hid_event(struct hid_device
*hid
, struct hid_field
*field
, struct hid_usage
*usage
, __s32 value
, struct pt_regs
*regs
) { }
487 static inline void hidinput_report_event(struct hid_device
*hid
, struct hid_report
*report
) { }
488 static inline int hidinput_connect(struct hid_device
*hid
) { return -ENODEV
; }
489 static inline void hidinput_disconnect(struct hid_device
*hid
) { }
492 int hid_open(struct hid_device
*);
493 void hid_close(struct hid_device
*);
494 int hid_set_field(struct hid_field
*, unsigned, __s32
);
495 void hid_submit_report(struct hid_device
*, struct hid_report
*, unsigned char dir
);
496 void hid_init_reports(struct hid_device
*hid
);
497 struct hid_field
*hid_find_field_by_usage(struct hid_device
*hid
, __u32 wanted_usage
, int type
);
498 int hid_wait_io(struct hid_device
* hid
);
502 int hid_ff_init(struct hid_device
*hid
);
504 static inline int hid_ff_init(struct hid_device
*hid
) { return -1; }
506 static inline void hid_ff_exit(struct hid_device
*hid
)
511 static inline int hid_ff_event(struct hid_device
*hid
, struct input_dev
*input
,
512 unsigned int type
, unsigned int code
, int value
)
515 return hid
->ff_event(hid
, input
, type
, code
, value
);