USB HID 协议入门
转载请注明来源:cuixiaolei的技术博客
USB HID设备类的应用场合
USB HID类是USB设备的一个标准设备类,包括的设备非常多。HID类设备定义它属于人机交互操作的设备,用于控制计算机操作的一些方面,如USB鼠标、USB键盘、USB游戏操纵杆等。但HID设备类不一定要有人机接口,只要符合HID类别规范的设备都是HID设备。
USB HID设备的一个好处就是操作系统自带了HID类的驱动程序,而用户无需去开发驱动程序,只要使用API系统调用即可完成通信。
USB HID设备类的通信管道
所有的HID设备通过USB的控制管道(默认管道,即端点0)和中断管道(端点1或端点2)与主机进行通信。
管道 要求 说明
控制(端点0) 必须 传输USB描述符、类请求代码以及供查询的消息数据
中断输入 必须 传输从设备到主机的输入数据
中断输出 可选 传输从主机到设备的输出数据
注:USB主机为PC,USB设备如鼠标等。
控制管道主要用于下面3个方面
- 接收/响应USB主机的控制请求以及相关的类数据
- 在USB主机查询时传输数据(如响应Get_Report请求等)
- 接收USB主机的数据
中断管道主要用于下面两个方面
- USB主机接收USB设备的异步传输数据
- USB主机发送有实时性要求的数据给USB设备
从USB主机到USB设备的中断输出数据传输是可选的,当不支持中断输出数据时,USB主机通过控制管道将数据传输给USB设备。
与USB HID设备有关的描述符
HID设备的描述符除了5个USB的标准描述符(设备描述符、配置描述符、接口描述符、端点描述符、字符串描述符)外,还包括三个HID设备类特定的描述符:HID描述符、报告描述符、实体描述符。
除了HID的三个特定描述符组成对HID设备的解释外,5个标准描述符中与HID设备有关的部分有:
- 设备描述符中:bDeviceClass, bDeviceSubClass, bDeviceProtocol三个值必须为0
- 接口描述符中:bInterfaceClass的值必须时0x03, bInterfaceSubClass的值为0或1, 为1表示HID设备是一个启动设备(Boot Device, 一般对PC机有意义,意思是BIOS启动时能识别您使用的HID设备,切只有标准鼠标或者键盘才能称为Boot Device),为0表示HID设备是操作系统启动厚才能识别使用的设备。bInterfaceProtocol的取值含义如下:
bInterfaceProtocol的取值(十进制) 含义
0 NONE
1 键盘
2 鼠标
3-255 保留
下面分别对3个HID设备类特定描述符进行说明:
1.HID描述符
HID描述符关联于接口描述符,因而如果一个设备只有一个接口描述符,则无论它有几个端点描述符,HID设备只有一个HID描述符。HID设备描述符主要描述HID规范的版本号, HID通信所使用的额外描述符, 报表描述符的长度等。下表为HID描述符的结构。
偏移量 域 大小 值 描述
0 bLength 1 数字 此描述符的长度,以字节为单位
1 bDescriptorType 1 常量 描述符种类(此处0X21为HID类)
2 bcdHID 2 数字 HID规范版本号(BCD码),采用4个16进制的BCD格式编码,如版本1.0,0x0100,版本1.1,0x10110
4 bCountryCode 1 数字 硬件目的国家的识别码
5 bNumDescriptors 1 数字 支持的附属描述符数目
6 bDescriptorType 1 常量 HID相关描述符的类型,见下表
7 wDescriptorLength 2 数字 报告描述符的总长度
9 bDescriptorType 1 常量 用于识别描述符类型的常量,使用有一个以上描述符的设备
10 wDescriptorLength 2 数字 描述符总长度,使用在有一个以上描述符的设备
HID相关描述符类型定义
描述符类型值 HID相关描述符类型
0x21 HID描述符
0x22 报表描述符
0x23 实体描述符
2.报告描述符
HID设备的报告描述符比较复杂,也比较难理解。
报告描述符的语法不同于USB标准描述符,它是以项目(item)方式排列而成,没有固定长度。HID的报告描述符已经不是简单的描述某个值对饮过的固定意义了,它已经能够组合出很多种情况,而且需要PC上的HID驱动程序提供parser解释器来对描述符的设备情形进行重新解释,进而组合生成本HID硬件设备独特的数据流格式,所以可以把它理解为“报告描述符脚本语言”更为贴切。我们使用“报告描述符”专用脚本语言,让用户来自己定义它们的HID设备都有什么数据,以及这些数据各个位(bit)都有什么意义。
有关报告描述符的详细信息可以参考USB HID协议,USB协会提供了一个HID描述符编辑工具称作HID Descriptor Tool,用它可以方便生成我们的报告描述符。
一个USB HID设备可以包含多种功能的报告描述符合集,这样可以实现复合设备,如带鼠标功能的USB键盘,这种复合键盘可以通过在报告描述符里包含鼠标和键盘两种报告实现,两个报告用报告ID来区分。
3.实体描述符
实体描述符被用来描述设备的行为特性。实体描述符是可选的描述符,HID设备可以根据其本体的设备特性选择是否包含实体描述符。HID的实体描述符结构如下表:
偏移量 域 大小 说明
0 bDesignator 1 用来指定本体的那一部分影响项目,见下表
1 bFlags 1 位指定标志
位0~4:Effort
位5~7:Qualifier,见下表
表7、bDesignator取值含义表 | ||||
bDesignator取值 | 含义 | bDesignator取值 | 含义 | |
0x00 | 无 | 0x15 | 小指 | |
0x01 | 手 | 0x16 | 头 | |
0x02 | 眼球 | 0x17 | 肩 | |
0x03 | 眉 | 0x18 | 腰骨 | |
0x04 | 眼皮 | 0x19 | 腰 | |
0x05 | 耳 | 0x1A | 大腿 | |
0x06 | 鼻 | 0x1B | 膝盖 | |
0x07 | 嘴 | 0x1C | 小腿 | |
0x08 | 上唇 | 0x1D | 足 | |
0x09 | 下唇 | 0x1E | 脚 | |
0x0A | 颚 | 0x1F | 脚跟 | |
0x0B | 颈 | 0x20 | 拇指 | |
0x0C | 上臂 | 0x21 | 大拇指 | |
0x0D | 手肘 | 0x22 | 第二指 | |
0x0E | 前臂 | 0x23 | 第三指 | |
0x0F | 手腕 | 0x24 | 第四指 | |
0x10 | 手掌 | 0x25 | 小拇指 | |
0x11 | 拇指 | 0x26 | 眉 | |
0x12 | 食指 | 0x27 | 脸 | |
0x13 | 中指 | 0x28~0xFF | 保留 | |
0x14 | 无名指 |
表8、Qualifier取值含义 | ||||
Qualifier取值 | 含义 | Qualifier取值 | 含义 | |
0x00 | 无 | 0x04 | 其中之一 | |
0x01 | 右 | 0x05 | 中间 | |
0x02 | 左 | 0x06 | 保留 | |
0x03 | 两者同时 | 0x07 | 保留 |
USB HID类命令(请求)
偏移量 | 域 | 大小 | 说明 |
0 | bmRequestType | 1 | HID设备类请求特性如下: 因而,针对HID的设备类请求,仅仅10100001和00100001有效 |
1 | bRequest | 1 | HID类请求(参考表10) |
2 | wValue | 2 | 高字节说明描述符的类型(参考表5),而低字节为非0值时被用来选定实体描述符。 |
4 | wIndex | 2 | 2字节数值,根据不同的bRequest有不同的意义 |
6 | wLength | 2 | 该请求的数据段长度 |
数值 | HID类请求描述符 | 注释 |
0x01 | GET_REPORT | |
0x02 | GET_IDLE | |
0x03 | GET_PROTOCOL | 仅仅适应于支持启动功能的HID设备(Boot Device) |
0x09 | SET_REPORT | |
0x0A | SET_IDLE | |
0x0B | SET_PROTOCOL | 仅仅适应于支持启动功能的HID设备(Boot Device) |
USB主机在请求HID设备的配置描述符时,设备需要按照顺序返回下面几种描述符:配置描述符, 接口描述符, HID描述符, 端点描述符。HID描述符里又包含了其附属的描述符的类型和长度(如报告描述符),然后主机再根据HID描述符的信息请求其相关的描述符。