6/27/01
Device Class Definition
for Human Interface
Devices (HID)
Firmware Specification—6/27/01
Version 1.11
Please send comments via electronic mail to:
hidcomments@usb.org
Universal Serial Bus (USB)
1996-2001 USB Implementers’ Forum
—
A
ll rights reserved.
iii
6/27/01
Contents
1. Preface........................................................................................................ vii
1.1 Intellectual Property Disclaimer ........................................................... vii
1.2 Contributors .......................................................................................... vii
1.3 Scope of this Revision.......................................................................... viii
1.4 Revision History ..................................................................................viii
1.5 Document Conventions.......................................................................... ix
2. Introduction .................................................................................................. 1
2.1 Scope....................................................................................................... 1
2.2 Purpose.................................................................................................... 2
2.3 Related Documents ................................................................................. 3
3. Management Overview ................................................................................ 4
4. Functional Characteristics ............................................................................ 7
4.1 The HID Class......................................................................................... 7
4.2 Subclass................................................................................................... 8
4.3 Protocols.................................................................................................. 9
4.4 Interfaces............................................................................................... 10
4.5 Device Limitations................................................................................ 11
5. Operational Model...................................................................................... 12
5.1 Device Descriptor Structure.................................................................. 12
5.2 Report Descriptors ................................................................................ 14
5.3 Generic Item Format ............................................................................. 14
5.4 Item Parser ............................................................................................ 15
5.5 Usages ................................................................................................... 17
5.6 Reports .................................................................................................. 17
5.7 Strings ................................................................................................... 18
5.8 Format of Multibyte Numeric Values ................................................... 19
5.9 Orientation ............................................................................................ 20
5.10 Null Values ....................................................................................... 20
6. Descriptors.................................................................................................. 21
6.1 Standard Descriptors ............................................................................. 21
6.2 Class-Specific Descriptors .................................................................... 21
6.2.1 HID Descriptor.............................................................................. 22
6.2.2 Report Descriptor.......................................................................... 23
6.2.2.1 Items Types and Tags............................................................ 26
6.2.2.2 Short Items ............................................................................ 26
iv Contents
6/27/00:
6.2.2.3 Long items............................................................................. 27
6.2.2.4 Main Items ............................................................................ 28
6.2.2.5 Input, Output, and Feature Items........................................... 29
6.2.2.6 Collection, End Collection Items .......................................... 33
6.2.2.7 Global Items.......................................................................... 35
6.2.2.8 Local Items............................................................................ 39
6.2.2.9 Padding.................................................................................. 42
6.2.3 Physical Descriptors...................................................................... 43
7. Requests ..................................................................................................... 48
7.1 Standard Requests................................................................................. 48
7.1.1 Get_Descriptor Request ................................................................ 49
7.1.2 Set_Descriptor Request................................................................. 50
7.2 Class-Specific Requests ........................................................................ 50
7.2.1 Get_Report Request ...................................................................... 51
7.2.2 Set_Report Request....................................................................... 52
7.2.3 Get_Idle Request........................................................................... 52
7.2.4 Set_Idle Request ........................................................................... 52
7.2.5 Get_Protocol Request ................................................................... 54
7.2.6 Set_Protocol Request .................................................................... 54
8. Report Protocol .......................................................................................... 55
8.1 Report Types......................................................................................... 55
8.2 Report Format for Standard Items......................................................... 55
8.3 Report Format for Array Items.............................................................. 56
8.4 Report Constraints ................................................................................ 57
8.5 Report Example..................................................................................... 57
Appendix A: Usage Tags ...................................................................................... 59
Appendix B: Boot Interface Descriptors.............................................................. 59
B.1 Protocol 1 (Keyboard)............................................................................... 59
B.2 Protocol 2 (Mouse) ................................................................................... 61
Appendix C: Keyboard Implementation ............................................................... 62
Appendix D: Example Report Descriptors ........................................................... 64
D.1 Example Joystick Descriptor .................................................................... 64
Appendix E: Example USB Descriptors for HID Class Devices.......................... 66
E.1 Device Descriptor...................................................................................... 66
E.2 Configuration Descriptor .......................................................................... 67
E.3 Interface Descriptor (Keyboard) ............................................................... 67
E.4 HID Descriptor (Keyboard)....................................................................... 68
E.5 Endpoint Descriptor (Keyboard)............................................................... 68
E.6 Report Descriptor (Keyboard)................................................................... 69
Contents v
6/277/00:
E.7 Interface Descriptor (Mouse) .................................................................... 70
E.8 HID Descriptor (Mouse) ........................................................................... 70
E.9 Endpoint Descriptor (Mouse).................................................................... 70
E.10 Report Descriptor (Mouse)...................................................................... 71
E.11 String Descriptors.................................................................................... 72
Appendix F: Legacy Keyboard Implementation................................................... 73
F.1 Purpose ...................................................................................................... 73
F.2 Management Overview ............................................................................. 73
F.3 Boot Keyboard Requirements ................................................................... 74
F.4 Keyboard: Non-USB Aware System Design Requirements...................... 75
F.5 Keyboard: Using the Keyboard Boot Protocol.......................................... 75
Appendix G: HID Request Support Requirements ............................................... 78
Appendix H: Glossary Definitions........................................................................ 79
