USB HID协议中文版 - USB接口HID设备 - 图文

第8章 USB接口HID设备

HID（Human Interface Device，人机接口设备）是USB设备中常用的设备类型，是直接与人交互的USB设备，例如键盘、鼠标与游戏杆等。在USB设备中，HID设备的成本较低。另外，HID设备并不一定要有人机交互功能，只要符合HID类别规范的设备都是HID设备。

Wndows操作系统最先支持的HID设备。在windows 98以及后来的版本中内置有 HID设备的驱动程序，应用程序可以直接使用这些驱动程序来与设备通信。

在设计一个USB接口的计算机外部设备时，如果HID类型的设备可以满足需要，可以将其设计为HID类型设备，这样可以省去比较复杂的USB驱动程序的编写，直接利用Windows操作系统对标准的HID类型USB设备的支持。

8.1 HID设备简介

8.1.1 HID设备的特点

? 交换的数据储存在称为报表（Report）的结构内，设备的固件必须支持HlD报表的

格式。主机通过控制和中断传输中的传送和请求报表来传送和接收数据。报表的格式非常灵活。

? 每一笔事务可以携带小量或中量的数据。低速设备每一笔事务最大是8B，全速设

备每一笔事务最大是64B，高速设备每一笔事务最大是1024B。一个报表可以使用多笔事务。

? 设备可以在未预期的时间传送信息给主机，例如键盘的按键或是鼠标的移动。所以

主机会定时轮询设备，以取得最新的数据。

? HID设备的最大传输速度有限制。主机可以保证低速的中断端点每10ms内最多1

笔事务，每一秒最多是800B。保证全速端点每lms一笔事务，每一秒最多是64000B。保证高速端点每125 us三笔事务，每一秒最多是24.576MB。

? HID设备没有保证的传输速率。如果设备是设置在10ms的时距，事务之间的时间

可能等于或小于10ms。除非设备是设置在全速时在每个帧传输数据，或是在高速时在每个微帧传输数据。这是最快的轮询速率，所以端点可以保证有正确的带宽可供使用。

HID设备除了传送数据给主机外，它也会从主机接收数据。只要能够符合HlD类别规范的设备都可以是HID设备。

设备除了HlD接口之外，它可能同时还包含有其他的USB接口。例如影像显示设备可能使用HID接口来做亮度、对比度的软件控制，而使用传统的影像接口来传送要显示的数据。USB扩音器可以使用实时传输来播放语音，同时使用HID接口来控制音量、低音等。

HID类别设备的规范文件主要是以下两份：

? Device Class Definition for Human interface Devices ? HID Usage Tables

其中前者是HID的基本规范文件，后者可以是前者的附件，为开发人员提供实际的控制类型的描述。文件是用来定义让主机了解以及使用HID数据的数值。这两份文件是由 USB Device Working Group制定的，可以在网址http://www.usb.org/developers/hidpage/ #Class _Definition下载。

182 计算机高级接口实践

8.1.2 HID设备的硬件要求

HID接口必须符合Device Class Definition for Human interface Devices规范内所定义的HID类别的需求。在此文件内描述了所需的描述符、传输的频率以及传输的类型等。为了符合规范，HID接口的端点与描述符都必须符合数个要求。

所有的HID传输都是使用默认控制管道或是一个中断管道，HID设备必须有一个中断输入端点来传送数据到主机，中断输出端点则不是必需的。

主机 HID类别 驱动程序 外设 默认控制管道 HID类别 设备 中断管道 图8-1 HID传输的传输类型

表8-1 HID设备的传输类型 传输 类型 控制 中断 数据来源 设备（输入） 主机（输出） 设备（输入） 主机（输出） 数据类型 没有严格时间限制的数据 没有严格时间限制的数据 或是没有中断输出管道时的任何数据 定时或低延迟的数据 定时或低延迟的数据 是否需 要管道 是 是 是

主机与设备之间所交换的数据，可以分成两种类型：

? 低延迟的数据，必须尽快地到达目的；

? 配置或其他的数据，没有严格时间限制的需求。

中断管道是控制管道之外的另一种数据交换的方式，特别适合使用在接收端需要定时或是尽可能及时收到数据的时候。中断输入管道携带数据到主机，中断输出管道则是携带数据到设备。在总线忙的时候，控制管道可能会被延迟，而中断管道保证会有可得到的带宽。HID不需要一定有中断输出管道。如果没有中断输出管道，主机会在控制管道上使用HID设备特有的Set_Report请求来传送所有的报表。

8.1.3 HID固件的要求

主机的驱动程序要与HID设备通信，设备的固件必须符合下列需求：

? 设备的描述符必须识别该设备包含有HID接口。

? 除了默认控制管道外，固件必须另外支持一个中断输入管道。 ? 固件必须包含一个报表描述符来定义要传送与接收的设备数据。

如果要传送数据，固件必须支持Get_Report控制传输与中断输入传输。如果要接收数据，固件必须支持Set_Report控制传输与选择性的中断输出传输。

所有的HID数据都必须使用定义过的报表格式来定义报表中数据的大小与内容。设备可以支持一个或多个报表。在固件中的一个报表描述符用来描述此报表，以及如何使用报表数据的信息。

第8章 USB接口HID设备 183

在每一个报表中的一个数值，定义此报表是一个输入（Input）、输出（Output）或是特征（Feature）报表。主机在输入报表中接收数据，在输出报表中传送数据，特征报表可以在任何方向传递。

Windows 98以及后来版本的HID驱动程序使用中断传输来传递输入报表。输出报表的传输类型要根据设备支持的端点与Windows的版本而定。Windows 98 Gold只符合HID 1.0规范，它的HID驱动程序使用控制传输来传递输出报表。Windows 98 SE、Wndows 2000符合HID 1.1规范，HID驱动程序在有中断输出端点时使用中断传输，否则使用控制传输来传递输出报表。特征报表都是使用控制传输。

8.2 HID设备描述符

HID设备连接到USB主机后，主机通过发送Get_Descriptor请求读取HID设备的描述符，了解描述符对了解USB设备是至关重要的。

8.2.1 HID设备的描述符

HID设备除了支持USB设备的5种标准描述符之外，还支持HID设备特有的3种描述符。这些描述符是：

? USB标准描述符：设备、配置、接口、端点和字符串描述符。

? HID特有的描述符：HID、报表（Report）和实体（Physical）描述符。 从描述符的关联关系看，HID描述符是关联于接口。所以如果一个HID设备有2个端点，设备不需要每个端点有一个HID描述符。

接口描述符Interface HID描述符 Hid 端点描述符 Endpoint 报表描述符 Report 实体描述符 Physical HID、报表和实体描述符是HID设备特有的描述符 图8-2 HID描述符的关联关系

从前面的USB描述符可以看出一个规律，描述符的第一、二字节分别是描述符的长度和类型，描述符的类型字段（bDescriptorType）表明描述符的种类，下表列出了不同描述符的类型字段数值。

表8-2 HID的描述符

184 计算机高级接口实践 类型 描述符 设备 Device 配置 Configuration 字符串 String 接口 Interface 端点 Endpoint 设备限定 Device_Qualiffier Other_Speed_Configuration Interface_power HID Hub 报表 Report 实体 Physical 应用 所有设备必须有，只能一个 所有设备必须有，至少一个 可选择 每一个接口一个 除端点0之外的每个端点一个 同时支持全速与高速的设备必须有一个 HID设备必须有 HID设备必须有 可选择的 数值 01 02 03 04 05 06 07 08 21 29 22 23 标准 类别 HID 特定 对于一个HID设备，设备描述符与配置描述符没有HID特定的信息。其设备描述符的bDeviceClass和bDeviceSubClass字段的值为0，接口描述符的bInterfaceClass字段值为03，表示设备的该接口是HID类别。在接口描述符中其他包含HID特定信息的字段还有子类别码（blnterfaceSubClass）与协议码（blnterfaceProtocol字段）。

在接口描述符中子类别码字段等于1表示此设备支持启动接口（Boot Interface）。如果设备有启动接口，即便主机的HID没有加载驱动程序，设备也可以使用。这种情形可能发生在计算机是由DOS直接启动，在启动时观看系统设置画面或使用Wndows的安全模式时。

含有启动接口的键盘或鼠标可以使用BIOS或许多主机支持的默认简单协议。HID规范定义了键盘与鼠标的启动接口协议。

如果设备没有启动接口，并且接口描述符中协议码字段是1，表示设备支持键盘接口，协议码字段是2，表示支持鼠标接口。接口描述符中协议码字段是0，表示设备不支持启动协议。

在 HID Usage Tables规范中定义了键盘与鼠标的启动描述符（Boot Descriptor）。BIOS不需要从设备中读取描述符，因为它知道启动协议，并且假设设备支持启动协议。所以要启动的设备不需要在固件内包含启动接口描述符，它只要在主机尚未要求在报表描述符中的定义协议时支持启动协议即可。在操作系统加载HlD驱动程序后会使用Set_Protocol请求，将设备由启动协议转换成报表协议。

8.2.2 HID描述符

HID描述符的主要作用是用来识别HID通信所使用的额外描述符。下表是HID描述符结构。

偏移 量 0 1 2 4 5 6 7 字段 bLength bDescriptorType bcdHID bCountryCode bNumDescriptors bDescriptorType wDescriptorLength 表8-3 HID描述符结构 字节 数值 说明 数 类型 1 Numeric 描述符字节数 1 Constant 0x21 = HID描述符 2 Numeric HID规范版本号（BCD） 1 Numeric 硬件设备所在国家的国家代码 1 Numeric 类别描述符数目（至少有一个报表描述符） 1 Constant 类别描述符的类型 2 Numeric 报表描述符的总长度 第8章 USB接口HID设备 185 9 10 [bDescriptorType]... [wDescriptorLength]... 1 2 Constant 附加的描述符的类型，可选的 Numeric 附加的描述符的总长度，可选的 bcdHID：设备与其描述符所遵循的HID规范的版本号码，此数值是4个16进位的BCD格式字符。例如版本1.1的bcdHID是0110h。

bCountryCode：硬件目的国家的识别码。如果不说明，该字段为0。 bDescriptorType：HID描述符附属的描述符的类型（报表或实体）。每一个 HID都必须至少支持一个报表描述符。一个接口可以支持多个报表描述符，以及一个或多个实体描述符。

HID描述符的偏移量为9和10的bDescriptorType和wDescriptorLength可以重复存在多个。

1. 报表描述符

报表描述符定义了执行设备功能的数据格式和使用方法。

报表描述符和USB的其他描述符是不一样的，它不是一个简单的表格，报表描述符是USB所有描述符中最复杂的。报表描述符非常复杂而有弹性，因为它需要处理各种用途的设备。报表的数据必须以简洁的格式来储存，这样才不会浪费设备内的储存空间以及数据传输时的总线时间。

实际上可以这样理解，报表内容的简洁，是通过报表描述符全面的、复杂的数据描述实现的。

报表描述符必须先描述数据的大小与内容。报表描述符的内容与大小因设备的不同而不同，在进行报表传输之前，主机必须先请求设备的报表描述符，只有得到了报表描述符才可正确解析报表的数据。

报表描述符是报表描述项目（Item）的集合，每一个描述项目都有相对统一的数据结构，项目很多，通过编码实现。

（1）项目

报表描述符由描述HID设备的数据项目（Item）组成，项目的第一个字节（项目前缀）由三部分构成，即项目类型（item type）、项目标志（item tag）和项目长度（item size）。其中项目类型说明项目的数据类型，项目标签说明项目的功能，项目长度说明项目的数据部分的长度。

HID的项目有短项目和长项目两种，其中短项目的格式如下图。

位序 字段

7 6 5 4 3 2 1 0

Data (可以是0、1、2、4个字节) bTag bType bSize 图8-3 HID报表短项目格式

短项目的数据字节数由bSize的值定义，bSize为0、1、2、3时Data部分的字节数分别为0、1、2、4个字节。短项目的项目类型由bType定义，bType为0、1、2时分别为Main、Global和Local类型。

长项目可以携带较多的数据，其格式如下图。

186 计算机高级接口实践

位序 字段 字节数

7 6 5 4 3 2 1 0

Data 1~255 bLongItemTag 1 bDataSize 1 1 1 1 1 1 1 0 1 1 图8-4 HID报表长项目格式

项目中的第一个字节为上图中的特定值时表明该项目是一个长项目。长项目中的bDataSize说明Data部分的字节数，bLongItemTag在HID规范中没有定义。

下面是通过汇编实现的一个简单的报表描述符，描述符的每一行是一个项目，该描述符描述了一个从设备接收2个字节的输入报表和发送2个字节到设备的输出报表。

HID_Report_desc_table: db 06h, A0h, FFh ; Usage Page(Vendor defined) 定义设备功能 db 09h, A5h ; Usage(Vendor Defined) 定义用法 db A1h, 01h ; Collection(Application) 开一个集合 db 09H, A6h ; Usage(Vendor defined) 定义用法 ; 输入报表 db 09h, A7h ; Usgae(Vendor defined) 定义用法 db 15h, 80h ; Logical Minimum 定义输入最小值=-128 db 25h, 7Fh ; Logical Maximum 定义输入最大值=+27 db 75h, 08h ; Report Size 定义报表数据项大小=8 db 95h, 02h ; Report Count 定义报表数据向个数=2 db 81h, 02h ; Input(Data,Variable,Absolute) 输入项目 ; 输出报表 db 09h, A9h ; Usgae(Vendor defined) 定义用法 db 15h, 80h ; Logical Minimum 定义输入最小值=-128 db 25h, 7Fh ; Logical Maximum 定义输入最大值=+27 db 75h, 08h ; Report Size 定义报表数据项大小=8 db 95h, 02h ; Report Count 定义报表数据向个数=2 db 91h, 02h ; Output(Data,Variable,Absolute) 输出项目 db C0h ; End Collection 关闭集合

（2）项目的分类

报表的项目有Main、Global和Local三大类，每一类都有多个不同的项目，实现不同的描述。

Main类项目用于定义报表描述符中的数据项。也可以组合其中的若干数据项成为一个集合。Main项目可以分为带数据的Main项目和不带数据的Main项目。带数据项的Main用于生成报表中的数据项，包括Input、Output和Feature项目。不带数据的Main项目不生成报表中的数据项，包括Collection和End Collection项目。

Global类项目实现对数据的描述，用来识别报表并且描述报表内的数据，包括数据的功能、最大与最小允许值以及数据项的大小与数目等。改变由Main类项目生成的项目状态表。Global类项目描述对后续的所有项目有效，除非遇到有新的Global类项目。

Local类项目定义控制的特征，这一类项目的作用域不超过下一个Main项目，所以在每一Main项目之前可能有多个Local项目。Local项目用于描述后面的Input、Output和Feature项目。

第8章 USB接口HID设备 187

下表列出的是全部的项目的前缀字和简要功能说明。 项目 类型 项目标志（Tag） Input Main 类项目 Output Feature Collection End Collection 表8-4 HID项目列表 项目前缀，nn功能说明 为数据长度 定义输入报表，主机利用该信息解析设备提供的数1000 00 nn 据。主机向控制端口发送Get_Report实现输入 创建输出报表，通过向设备发送Set_Report实现输1001 00 nn 出 定义送往设备的设置信息 1011 00 nn 定义2个以上数据（Input、Output和Feature）的1010 00 nn 关系为集合，Collection开始一个集合，之后的End Collection结束集合。Collection项目的数据部分说1100 00 nn 明Collection的类型 0000 01 nn 0001 01 nn 0010 01 nn 0011 01 nn 0100 01 nn 0101 01 nn 0110 01 nn 0111 01 nn 1000 01 nn 1001 01 nn 1010 01 nn 1011 01 nn 1100 01 nn – 1111 01 nn 0000 10 nn 0001 10 nn 0010 10 nn 0011 10 nn 0100 10 nn 0101 10 nn 0111 10 nn 1000 10 nn 1001 10 nn 1010 10 nn 1010 10 nn – 1111 10 nn Usage Page Logical Minimum Logical Maximum Physical Minimum Global Physical Maximum 类项Unit Exponent 目 Unit Report Size Report ID Report Count Push Pop Usage Usage Minimum Usage Maximum Designator Index Designator Minimum Designator Maximum String Index String Minimum String Maximum Delimiter 指定设备的功能 另外由于Usage项目有32位数据值，Usage Page项目用于为Usage项目在报表描述符中占居存储空间。用于存放后续的Usage项目的高16位。 定义变量或数组项目的逻辑最小值和最大值 定义变量或数组项目的物理最小值和最大值，分别和Logical Minimum、Logical Maximum对应 定义数值是基于10的指数 单位 指定报表数据区域所包含的位数 报表ID，该项目在报表中插入一个字节的报表ID 报表中数据域的数目 将Global项目状态表送入堆栈 从堆栈恢复Global项目状态表 保留 用法索引值，表示对项目或集合建议的用法，用于当一个项目描述多个控制，对每一个变量和数组元素都有建议的用法 定义阵列或位图中控制操作的第一个和最后一个用法 确定用于控制的实体，指向物理描述符中的目标 定义阵列或位图目标的起始和终止索引值 确定字符串描述符中的索引值 定义用于阵列或位图控制中字符串序列索引值的最小值和最大值 定义一组Local项目的开始和结束，1=开始，0=结束 保留 Local 类项目 在这些项目中，Usage Page用来指定设备的功能，而Usage项目用来指定个别报表的功能。Usage Page项目相当于是HID的子集合，Usage相当于是Usage Page的子集合。

2. 报表描述符的项目

188 计算机高级接口实践

（1）Input、Outpot和Feature项目

这3个项目用来定义报表中的数据字段。

Input项目可以应用到任何控制、计数器读数或其他设备传给主机的信息。一个输入报表包含一个或多个Input项目，主机使用中断输入传输来请求输入报表。

Ouput项目用来定义主机传送给设备的信息。一个输出报表包含一个或多个Outpot项目。输出报表包含控制状态的数据。如果有中断输出管道，HID1.1兼容主机使用中断输出传输来传送输出报表，否则使用Set_Report控制请求。

Feature项目应用到主机传送给设备的信息，或是主机从设备读取Feature项目。一个特征报表包含一个或多个Feature项目，Feature项目通常是包合影响设备与其组件整体行为的配置。特征报表通常是控制可以使用实际的控制面板调整的设置，例如主机可以使用虚拟控制面板来让用户选择控制特征。主机使用 Set_Report与Get_Report请求来传送与接收特征报表。

在每一个Input、Output和Feature项目的前缀字之后是32位描述数据，目前最多定义了9个位，余的位则是保留。位0~8的定义中只有位7不能应用于Input项目，除此之外其他的位定义都适应于Input、Output和Feature项目。

位 0 值 0 1 0 1 1 0 2 1 3 ① 4 ① 5 ① 0 1 0 1 0 1 0 6 ① 1 表8-5 Input、Output和Feature项目的数据项说明 数据字段 含义说明 名称 数据：表示项目的内容是可更改的（读/写）。 Data Constant 常数：表示项目的内容是不可更改的（只读）。 数组：报告全部控制的状态。如在键盘报表中每一个键在报表中Array 占一位，报表传输全部键的状态，可以同时按下任意多个键。 变量：报告作用中的控制。如在键盘报表中只报告按下的键的编号，可以同时按下的键的数目等于报表的计数（Global类项目Variable Report Count） 绝对：表示数值以一个固定值为基准。游戏杆通常是报告绝对数Absolute 据（游戏杆目前的位置）。 相对：表示数据的改变以上一个读数为基准。鼠标通常是报告相Relative 对数据（鼠标的移动位置）。 No Wrap 如果设置为1表示回转，当数值超过最小值到最大值的范围时将回转，如果最小值是0而最大值是10，超过最大值的下一个数Wrap 值是0。 线形：表示测量的数据与报表的数据有线性的关系。 Linear Non-Linear 非线性：表示测量的数据与报表的数据没有线性的关系。 优选状态：表示控制在没有用户交互时会回到一个特定的状态。Preferred 如按钮就有优选状态，在无操作时保持未按下的状态。 非优选状态：它维持在上一个用户选择的状态。如交替的开关就Non-Preferred 没有优选状态。 No Null Position 无空状态位置：表示控制永远在传送有效的数据。 空状态：表示控制支持一个没有传送有效数据的状态。如操纵杆可能具有一个多方向的按钮开关，在没有按下时在空状态，这时Null State 控制将传送一个在 Logical Minimum与Logical Maximum范围之外的数值来表示它在空状态。 不可变的：表示设备只有在主机请求时才改变数值。当主机传送一个报表并且不要改变不可变项目时，如果该项目是定义成相对Non-Volatile （Relative）的，数值0表示不改变数据，如果不可变项目是定义成绝对（Absolute）的，超出范围外的数值则表示不改变数据。 7 ② 0 第8章 USB接口HID设备 189 1 Volatile 0 Bit Field 1 Buffered Bytes 可变的：表示设备可以自己改变数值，并不是必须主机传送报表要求给设备来改变数值。例如设备控制面板可以由主机软件传送一个报表给设备，也可以由用户自己按设备上的实际按钮。 位字段：表示每一个位或是一个字节内的一组位可以代表一份数据。 缓冲字节：表示信息包含一个或多个字节，缓冲字节的报表大小必须是8。 保留 8 ① 9~31位 注： ①：该位不能应用到数组。

②：只应用于Output和Feature项目，对于Input项目该位保留。

（2）Collection和End Collection项目

所有的报表类型都可以使用Collection与 End Collection项目来将相关的Main类型项目组成群组。这两个项目分别用于打开和关闭集合。所有在Collection与End Collection项目之间的Main类型项目都是 Collection的一部分。

Collection有3种类型：Application、Physical与Logical，其项目的数据项的值分别为1、0和2。厂商也可以自己定义Collection类型，数据项的值为80h~FFh保留给厂商定义。End Collection项目无数据项。

Application Collection包含有共同用途的项目或执行单一功能的项目。例如键盘的开机描述符将键盘的按键与LED指示灯数据集合成一个Application Collection。所有的报表必须在一个Application Collection内。

Physical Collection包含在一个单一几何点上的数据项目，可以将每个位置的数据集合成一个 Physical Collection。在设备报告多个传感器的位置的时候，使用Physical Collection指明不同的数据来自不同的传感器。

Logical Collection形成一个数据结构，包含由 Collection所连结的不同类型的项目。例如数据缓冲区的内容以及缓冲区内字节数目的计数。

（3）Usage Page和Usage项目

Usage page项目的数据部分为1~2个字节，目前的定义全部都是一个字节。Usage Page定义了常用的设备功能，关于Usage Page（以及其他项目）的具体定义内容，可以查阅HID Usage tables（http://www.usb.org/developers/hidpage/#Class_Definition），下表是来自HID Usage tables的Usage Page定义。

Page ID 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 表8-6 Usage Page定义 Page Name Undefined Generic Desktop Controls Simulation Controls VR Controls Sport Controls Game Controls Generic Device Controls Keyboard/Keypad LEDs Button Ordinal Telephony Consumer Digitizer Reserved 190 计算机高级接口实践 0F PID Page 10 Unicode 11-13 Reserved 14 Alphanumeric Display 15-3f Reserved 40 Medical Instruments 41-7F Reserved 80-83 Monitor pages 84-87 Power pages 88-8B Reserved 8C Bar Code Scanner page 8D Scale page 8E Magnetic Stripe Reading (MSR) Devices 8F Reserved Point of Sale pages 90 Camera Control Page 91 Arcade Page 92-FEFF Reserved FF00-FFFF Vendor-defined

关于Usage Page的每一个有效定义项，都有一个相应的下一级定义，如Usage Page的数据项数值为1，则设备定义为Generic Desktop Controls，关于该类设备的具体功能可以在HID Usage Tables中查到具体的定义。下表是HID Usage Tables中对Generic Desktop Controls设备的功能定义。

表8-7 Generic Desktop Controls 用法定义 Usage ID 00 01 02 03 04 05 06 07 08 09 0A-2F 30 31 32 33 34 35 36 37 38 39 3A Usage Name Undefined Pointer Mouse Reserved Joystick Game Pad Keyboard Keypad Multi-axis Controller Tablet PC System Controls Reserved X Y Z Rx Ry Rz Slider Dial Wheel Hat switch Counted Buffer Usage Type CP CA CA CA CA CA CA CA DV DV DV DV DV DV DV DV DV DV CL 参阅HID Usage Tables中的相关章节 4.1 4.1 4.2 4.3 4.6

3B 3C 3D 3E 3F 40 41 42 43 44 45 46 47 48 49-7F 80 81 82 83 84 85 86 87 88 89 8A 8B 8C 8D 8E 8F 90 91 92 93 94-9F A0 A1 A2 A3 A4 A5 A6 A7 A8 A9-AF B0 B1 B2 B3 B4 B5 B6 B7 B8-FFFF 第8章 USB接口HID设备 191 Byte Count DV Motion Wakeup OSC Start OOC 4.3 Select OOC Reserved Vx DV Vy DV Vz DV Vbrx DV 4.3.1 Vbry DV Vbrz DV Vno DV Feature Notification DV,DF 4.8 Resolution Multiplier DV Reserved CA System Control 4.5 System Power Down OSC System Sleep OSC 4.5.1 System Wake Up OSC System Context Menu OSC System Main Menu OSC System App Menu OSC System Menu Help OSC System Menu Exit OSC 4.5 System Menu Select OSC System Menu Right RTC System Menu Left RTC System Menu Up RTC System Menu Down RTC System Cold Restart OSC 4.5.1 System Warm Restart OSC D-pad Up OOC D-pad Down OOC 4.7 D-pad Right OOC D-pad Left OOC Reserved System Dock OSC System Undock OSC 4.5.1 System Setup OSC System Break OSC System Debugger Break OSC 4.9 Application Break OSC Application Debugger Break OSC System Speaker Mute OSC 4.5.1 System Hibernate OSC Reserved System Display Invert OSC System Display Internal OSC System Display External OSC System Display Both OSC 4.10 System Display Dual OSC System Display Toggle Int/Ext OSC System Display Swap OSC Primary/Secondary System Display LCD Autoscale OSC Reserved 192 计算机高级接口实践

用法（Usage）定义了各种各样设备特性，对于Usage Page的每一项都定义了常用的各种用法。

用法说明了3种信息，即控制、集合和数据。控制说明设备的状态，如on/off、Enable/Disable等。集合说明控制和数据的组合关系。

上表中的用法类型（Usage Type）描述了应用程序如何处理由Main类型项目生成的数据，具体的定义和详细说明请参阅HID Usage Tables。

（4）Report ID项目

Report ID放在信息包中报表数据之前，设备可以支持多个相同类型的报表，每一个报表包含不同的数据与其特有的ID。

在报表描述符中，Report ID项目作用于其后续所有的项目，直到遇到下一个Report ID为止。如果报表描述符中没有Report ID项目，默认的ID值是0，描述符不能定义一个为0的Report ID，输入报表、输出报表与特征报表可以分享同一个Report ID。

在Set_Report和Get_Report请求传输中，主机在设置事务的 wValue字段的低字节中指定一个Report ID。在中断传输中如果接口支持一个以上的 Report ID，Report ID必须是传送报表中的第一个字节。如果接口只支持数值为0的默认Report ID，此Report ID不应该在中断传输中随着报表一起传送。

（5）Logical Minimum和Logical Maximum项目

Logical Minimum与 Logical Maximum项目定义报表的变量（Variable）或阵列（Array）数据的限制范围，此限制范围以逻辑单位来表示。例如设备报表的一个电流值读数是500mA，而一个单位是2mA，则 Logical Maximum值等于250。

负数值以2的补码来表示。如果Logical Minimum与Logical Maximum都是正数，就不需要有正负号位。不管 Logical Minimum与Logical Maximum是以有正负号或是无正负号的数值来表示，设备都可以正确地传输数据。数据的接收者必须知道数据是否可以是负值。

（5）Physical Minimum和Physical Maximum项目

Physical Minimum和Physical Maximum项目定义数值的限制范围，该限制范围使用Unit项目定义的单位来表示。上例中设备报表的一个电流值读数是500mA，单位是2mA， Logical Maximum值等于250，而Physical Maximum值是500。

Logical Minimum与 Logical Maximum值说明了设备返回数值的边界，可以根据Physical Minimum和Physical Maximum值对数据进行偏移和比例变换。

（6）Unit Exponent项目

Unit Exponent项目定义了在使用逻辑范围和实际范围将设备的返回数值转换成实际数值时，使用10的多少次方对数值进行定标。Unit Exponent的值的编码为4位补码，代表10的指数范围是-8~+7。

表8-8 Unit Exponent 数值表 代码 00h 01h 02h 03h 04h 05h 06h 07h 08h 09h 0Ah 0Bh 0Ch 0Dh 0Eh 0FH 1 2 3 4 5 6 7 -8 -7 -6 -5 -4 -3 -2 -1 数值 0 根据以上5个项目的值可以换算出报表传送数据（逻辑数据）与物理数据的转换关系。

物理数据值 = 逻辑数据值÷分辨率

分辨率 = （LogicalMaximum - LogicalMinimum）÷

（（PhysicalMaximum - PhysicalMinimum）×10UnitExponent）

第8章 USB接口HID设备 193

（7）Unit项目

Unit项目指定报表数据在使用Physical与Unit Exponent项目转换后使用什么度量单位，以及单位的幂指数值。Unit的数值部分可以长达4字节，按照4位为一段分段，可以分为8个半字节段，由高到低分别为半字节7、半字节6、…、半字节0。每一个半字节对应不同的基本单位，其数值表示单位的指数值，采用4位2的补码表示，取值范围是-8~+7之间。

从半字节0~6由下表给出了具体的定义，其中半字节0表示测量系统，半字节7保留。例如在半字节0数值为1（表示采用线性公制测量系统）的条件下，半字节1表示长度（单

2

位为厘米），如果其数值为1表示厘米，数值为2表示（厘米），成为面积单位。半字节3表示时间（单位为秒），如果其数值为-2，表示（秒）-2。

半字节 序号 0 1 2 3 4 5 6 7 测量 项目 测量系统 长度 质量 时间 温度 电流 亮度 保留 0 表8-9 Unit 单位的定义 数值含义 1 2 3 4 线性、公制 角度、公制 线性、英制 角度、英制 厘米 半径 英寸 度 克 石拉（slug） 秒 开式度（Kelvin） 华式度 安培 烛光 无 虽然表中只是定义了有限的基本单位，但可以通过这些基本单位的组合派生出大多数其它的常用单位。

例如报表使用一个字节传送一个从-20到110华氏度温度值，可以定义以下报表描述项目：

Logical Minimum = -128 Logical Maximum = 127 Physical Minimum = -20 Physical Maximum = 110 Unit Exponent = 0 Unit = 30003h

Unit的半字节0=3选择英制线性测量系统，半字节4=3选择华氏温度单位。

130（110+20）华氏度的数值范围线性分布到了256和有效数值区域，每一位相当于0.51华氏度，这样就提高了分辨率。

（8）Report Size和Report Count项目

Report Size项目指定Input、Output与Feature项目字段的大小，以位为单位。 Report Count项目指定Input、Output与Feature项目包含的字段数目。 例如两个8位的字段，Report Size等于8，而Report Count等于2。8个1位的字段，Report Size等于1，而 Report Count等于8。

Input、Output与Feature项目报表可以有多个项目，每一个项目可以有自己的Report Size和Report Count项目。

（9）Push和Pop项目

Push项目将一个Global项目状态表格的副本压入CPU的堆栈内。GIobal项目状态表格包含所有之前定义的Gobal项目的目前设置。

Pop项目恢复之前压入堆栈的Global项目状态的储存状态。

194 计算机高级接口实践

（10）Usage、Usage Minimum和Usage Maximum项目

这3个项目输入Local类型项目。

Usage项目和Global类型的Usage Page项目协同描述项目或集合的功能。 一个报表可以指定一个Usage给许多个控制，或是指定不同的Usage给每一个控制。如果一个报表项目之前有一个Usage，此Usage应用到该项目的所有控制。如果一个报表项目之前有一个以上的Usage，每一个Usage应用到一个控制，Usage与控制是按顺序结合的。

例如下面报表描述符的一个局部，报表含有2个输入字节，第一个字节的用法是x，第2个字节是y。

Report Size (8) Report Count (2) Usage (x) Usage (y) Input (Data, Variable, Absolute)

如果一个报表项目之前有一个以上的Usage，而且控制的数目多于Usage的数目，每一个Usage与一个控制对应，最后一个Usage则应用到所有剩余的控制。

例如在下面报表包含16个字节输入数据，第一个字节对应用法x，第2个字节对应用法y，剩余的14个字节对应厂商定义的用法。

Usage (x) Usage (y) Usage (Vendor defined) Report Size (8) Report Count (16) Input (Data, Variable, Absolute)

Usage Minimum和Usage Maximum可以指定一个 Usage给多个控制或是数组项目。将从Usage Minimum到Usgae Maximun定义的用法顺序对应到多个控制中。

例如在一个键盘描述符中定义的标准键盘的左、右修饰键的输入项目中，使用一个字节的8位分别输入键盘的左、右Ctrl键、Shift键、Alt键和GUI键，从HID Usage tables文档中的第10节可以查到关于键盘用法的定义，其中上述8个修饰键的用法定义值为224到231。以下是报表描述符的修饰键部分描述。

Usage Page (1) ; 1 = Generic Desktop Controls Usage (6) ; 6 = Keyboard Collection (1) ; 1 = Application Usage Page (7) ; 7 = Keyboard/Keypad Usage Minimum (224) Usage Maximum (231) Logical Minimum (0) Logical Maximum (1) Report Size (1) Report Count (8) Input (Data, Variable, Absolute) ……

8.3 USB接口的键盘描述符范例

第8章 USB接口HID设备 195

下面作为一个例子，介绍一个USB接口的101键盘的全部描述符。该键盘固件部分由一个微处理器实现全部控制功能，下面列出的代码为微处理器汇编实现描述符定义。

8.3.1 设备的描述符

设备描述符的代码如下。

;========================================= ; Device descriptor 设备描述符

;========================================= DEVICE_DESC_DATA: DB 0x12 ; bLength = 18，该描述符长度为18字节 DB 0x01 ; bDescriptorType = 01，表明是设备描述符 DB 0x10, 0x01 ; bcdUSB，USB设备版本号=1.1 DB 0x00 ; DeviceClass，设备类码，HID设备为0，类别在接口描述符中定义 DB 0X00 ; DeviceSubClass，设备子类码，DeviceClass为0时该字段必须为0 DB 0X00 ; bDevicePortocol，协议码，DeviceClass为0时该字段必须为0 DB 0x08 ; bMaxPacketSize0，端点0的最大包尺寸 DB 0xFF, 0xFF ; bVendor，厂商ID，由USB实现者论坛确定的 DB 0x01, 0x00 ; bProduct，产品ID

DB 0x00, 0x01 ; bcdDevice，设备版本号为1.00 DB 0x04 ; iManufacturer，厂商字符串的索引值，见字符串描述符 DB 0x0E ; iProduct，产品字符串的索引值，见字符串描述符 DB 0x30 ; iSerialNumber，产品序列号字符串的索引值，见字符串描述符 DB 0X01 ; bNumConfigurations，配置数目只有1个

8.3.2 配置描述符

配置描述符的代码如下。

;========================================= ; Configuration descriptor 配置描述符 ;========================================= CONFIG_DESC_DATA: DB 0x09 ; bLength=9，该描述符长度为9字节 DB 0x02 ; bDescriptorType = 02，表明是配置描述符 DB 0x3B, 0x00 ; wTotalLength = 59，配置、接口、端点和HID描述符的总和字节数 DB 0x02 ; bNumInterfaces = 2，本配置支持的接口数目为2个 DB 0x01 ; bConfigurationValue = 1，本配置描述符的标识符 DB 0x00 ; iCongfiguration = 0，配置描述符说明字符串的索引值，0表示无 DB 0XA0 ; bmAttributes，电源及唤醒设置，USB1.1版中D7=1，D6=0表示总线供电 ; D5=1表示支持远程唤醒 DB 0X32 ; MaxPower = 50，本设备最大耗电为50X2mA=100mA 需要说明的是wTotalLength的值，该数值为配置描述符长度（9）加上后续的键盘的接口描述符长度（9）、端点描述符长度（7）、HID描述符长度（9），以及该配置下的鼠标的接口描述符长度（9）、端点描述符长度（7）、HID描述符长度（9），共59个字节。关于鼠标的相关描述符在下面的叙述中省略了。

196 计算机高级接口实践

8.3.3 接口描述符

接口描述符的代码如下。

;========================================= ; Interface descriptor 接口描述符 ;========================================= InterfaceDescriptor0: DB 0x09 ; bLength = 9，该描述符长度 DB 0x04 ; bDescriptorType = 4，表明是接口描述符 DB 0x00 ; bInterfaceNumber = 0，此接口的识别标识符 DB 0x00 ; bAlternateSetting = 0，表示此接口无替代设置值 DB 0x01 ; bNumEndpoints = 1，本接口的端点数目，HID设备使用端点1 DB 0x03 ; bInterfaceClass = 3，表示该设备是HID类别 DB 0x01 ; bInterfaceSubClass = 1，表示支持启动接口 DB 0x01 ; bInterfaceProtocol = 1，表示支持键盘协议 DB 0x00 ; iInterface = 0，接口描述符说明字符串的索引值，0表示无字符串 8.3.4 HID描述符

HID描述符的代码如下。

;========================================= ; HID descriptor HID描述符 ;========================================= HIDDescriptor0: DB 0x09 ; bLength = 9，该描述符长度 DB 0x21 ; bDescriptorType = 21h，表明是HID描述符 DB 0x00, 0x01 ; bcdHID = 0100，HID规范版本为1.00 DB 0x00 ; bCountryCode = 0，硬件设备所在国家的国家代码，0表示未指明 DB 0x01 ; nNumDescriptors = 1，表示支持的描述符有1个，即一个报表描述符 DB 0x22 ; bDescriptorType = 22h，描述符类别，表示支持的描述符是报表描述符 DB 0x3F, 0x00 ; wDescriptorLength = 63，表示支持的报表描述符的长度 8.3.5 端点描述符

端点描述符的代码如下。

;========================================= ; EndPoint descriptor 端点描述符 ;========================================= EndpointDescriptor0: DB 0x07 ; bLength = 7，该描述符长度 DB 0x05 ; bDescriptorType = 5，表明是端点描述符 DB 0x81 ; bEndpointAddress = 1000 0001b，表示1号输入端点 DB 0X03 ; bmAttributes = 00000011b，表示中断类型端点 DB 0x08, 0x00 ; wMaxPacketSize = 8，端点发送和接收的最大包尺寸为8 DB 10 ; bInterval = 10，表示中断端点轮询时间间隔为10ms 8.3.6 字符串描述符

字符串描述符的代码如下。

第8章 USB接口HID设备 197

;========================================= ; String descriptor 字符串描述符

;========================================= StringDescriptor0: DB 0x04 ; bLength = 4，字符串描述符0的长度为4 DB 0x03 ; bDescriptorType = 3，表明是字符串描述符 DB 0x09, 0x00 ; wLANGID = 0009h，表明是英语 DB 0x0A ; bLength = 10，字符串描述符的长度为10 DB 0x03 ; bDescriptorType = 3，表明是字符串描述符 DB 0x41, 0x00, 0x43, 0x00, 0x4D, 0x00, 0x45, 0x00 ; bString = “ACME“，Unicode编码的字符串 DB 0x22 ; bLength = 34，字符串描述符的长度为34 DB 0x03 ; bDescriptorType = 3，表明是字符串描述符 DB 0x4C, 0x00, 0x6F, 0x00, 0x63, 0x00, 0x61, 0x00 DB 0x74, 0x00, 0x6F, 0x00, 0x72, 0x00, 0x20, 0x00 DB 0x4B, 0x00, 0x65, 0x00, 0x79, 0x00, 0x62, 0x00 DB 0x6F, 0x00, 0x61, 0x00, 0x72, 0x00, 0x64, 0x00 ; bString = “Locator Keyboard“，Unicode编码的字符串 DB 0x0E ; bLength = 14，字符串描述符的长度为14 DB 0x03 ; bDescriptorType = 3，表明是字符串描述符 DB 0x41, 0x00, 0x42, 0x00, 0x43, 0x00, 0x21, 0x00 DB 0x22, 0x00, 0x23, 0x00 ; bString = “ABC123“，Unicode编码的字符串

8.3.7 报表描述符

报表描述符的代码如下。

;========================================= ;HID Reports Descriptor 报表描述符

;========================================= DB 0x05, 1 ; Usage Page (1: Generic Desktop) DB 0x09, 6 ; Usage (6: Keyboard) 表示报表定义的是HID键盘 DB 0xA1, 1 ; Collection (1: Application) ====================集合开始 ; ; 以下定义了键盘的修饰键输入报表，共有8个键，组成一个字节 ; 用法见HID Usage Table中的第10节中的键盘用法定义 DB 0x05, 7 ; Usage page (7: Key Codes) DB 0x19, 224 ; Usage Minimum (224) DB 0x29, 231 ; Usage Maximum (231) DB 0x15, 0 ; Logical Minimum (0) DB 0x25, 1 ; Logical Maximum (1) DB 0x75, 1 ; Report Size (1) DB 0x95, 8 ; Report Count (8) DB 0x81, 2 ; Input (Data,Variable,Absolute) ; ; 以下定义了一个保留字节的输入报表 DB 0x95, 1 ; Report Count (1) DB 0x75, 8 ; Report Size (8), DB 0x81, 1 ; Input (Constant) = Reserved Byte ; ; 以下定义了键盘的LED指示灯输出报表项目，共有5个指示灯 ; 用法见HID Usage Table中的第11节中的LED用法定义 DB 0x95, 5 ; Report Count (5) DB 0x75, 1 ; Report Size (1)

198 计算机高级接口实践 DB 0x05, 8 ; Usage Page (Page# for LEDs) DB 0x19, 1 ; Usage Minimum (1) DB 0x29, 5 ; Usage Maximum (5) DB 0x91, 2 ; Output (Data, Variable, Absolute) ; ; 以下定义了3个填充位，与前面的5个LED指示灯数据组成一个完整的字节 DB 0x95, 1 ; Report Count (1) DB 0x75, 3 ; Report Size (3) DB 0x91, 1 ; Output (Constant) ; ; 以下定义了键盘的按键值输入报表项目，共6个字节，存放键编号（0~101） ; 用法见HID Usage Table中的第10节中的键盘用法定义 ； 这样的设计可以允许一次输入6个按键的键值 DB 0x95, 6 ; Report Count (6) DB 0x75, 8 ; Report Size (8) DB 0x15, 0 ; Logical Minimum (0) DB 0x25, 101 ; Logical Maximum (101) DB 0x05, 7 ; Usage Page (7: Key Codes) DB 0x19, 0 ; Usage Minimum (0) DB 0x29, 101 ; Usage Maximum (101) DB 0x81, 0 ; Input (Data, Array)

DB 0xC0 ; End_Collection ================================ 集合结束

通过上面的报表描述符的定义，确定了键盘的输入报表和输出报表的数据格式。其中输入报表共8个字节，输出报表只有1个字节。

键值6 字节7

键值5 字节6

键值4 键值3 键值2 字节3

键值1 保留 修饰键 字节0

字节5 字节4 字节2 字节1

图8-4 键盘的输入报表格式

7~5 4 3 2 1 0 字节0 Nnm Lock 指示灯 Caps Lock 指示灯 Scroll Lock 指示灯 Compose 指示灯 Kana 指示灯 常数，保留 图8-5 键盘的输出报表格式

第8章 USB接口HID设备 199

8.4 HID的特定请求

除了USB设备的11个标准请求外，HID规范另外还定义了6个HID特定控制请求。所有的HID设备都必须支持Get_Report请求，同时支持启动的设备必须支持Get_Protocol请求和Set_Protocol请求，其他的请求是可选择的。如果设备没有中断输出端点，此设备需要支持Get_Report请求来从主机读取数据。

在控制传输的设置阶段的数据包中的8个字节中的第一字节bmRequestType的编码含义参阅第6章中的USB标准请求。第2个字节bRequest定义请求的内容。wValue因请求的不同而不同。wIndex指明HID所在的接口。

表8-10 HID特定的请求 bmRequestType bRequest （值） 1 01 00001b 0 01 00001b 1 01 00001b 0 01 00001b 1 01 00001b 0 01 00001b Get_Report (1) Set_Report (9) Get_Idle (2) Set_Idle (10) Get_Protocol (3) Set_Protocol (11) wValue wIndex wLength 数据阶段 报表 报表 闲置时间 无 0: 启动协议 1: 报表协议 无 报表类型，报表ID 接口 报表长度 报表类型，报表ID 接口 报表长度 0，报表ID 接口 1 0 1 0 闲置时间，报表ID 接口 0 0: 启动协议 1: 报表协议 接口 接口 8.4.1 Get_Report请求

Get_Report的作用是启用主机使用控制传输，来从设备读取数据。

在使用时wValue字段的高字节是报表类型，1表示Input报表，2表示Output报表，3表示Feature报表。wValue的低字节是报表的Report ID，如果没有定义Report ID，该字节为设0。

在携带请求的控制传输的数据阶段，HID设备回传指定的报表内容。

HlD规范不建议使用该请求获得未经定时的数据，这样的数据建议使用中断输入管道获得。

该请求用来取得在主机初始化设备时的特征项目状态和其他信息。使用开机协议的主机可以使用此请求来获得按键或鼠标数据。

8.4.2 Set_Report请求

Set_Report请求的参数含义和Get_Report一样，但Set_Report请求的数据方向与Get_Report相反，在后面的数据阶段，主机传送报表到HID设备，这样的输出报表可以用于复位设备的控制，复位产生的效果取决于对应的控制的类型是相对（Reletive）的还是绝对（Absolute）的。

8.4.3 Set_Idle请求

Set_Idle请求的作用是静默一个在中断输入管道的特定的报表，直到一个发生一个相关的事件或过去了规定的时间，当数据从上一个报表后没有改变时，可以通过限制中断输入端点的报表频率来节省传输带宽。HID设备不是必需支持此请求。

wValue字段的高字节是设置的闲置时间，是报表之间的最大间隔时间。该字节为0表示闲置时间为无限长，在这种情况下，设备只有在报表数据有改变时才传送报表，否则

200 计算机高级接口实践

设备传回一个NAK。

wValue字段的低字节指示此请求应用的报表的Report ID。如果低字节是0，此请求应用到设备的所有输入报表。

闲置时间以4ms为单位，范围在4ms～1020ms之间。如果报表的数据自从上一次报表后有改变，或是接收到一个请求，设备会传送一个报表。

如果报表的数据没有改变，而且从上一次报表后过去的时间自尚未达到规定的闲置时间，设备会传回一个NAK。如果报表的数据没有改变，而且持续时间已经达到的闲置时间，设备会传送一个报表。

闲置时间设置为0表示无限长的闲置时间，设备只有在报表的数据有改变时才会传送一个报表，对于其他的中断输入请求则是传回NAK。

在检测HID设备时，Wndows的HID驱动程序会试图将闲置时间设置成0。如果HID设备不支持此请求，主机会收到传回的Stall。

8.4.4 Get_Idle请求

Get_Idle请求的作用是过的设备的当前闲置时间，在数据阶段，HID设备回传一个字节的闲置时间值。

8.4.5 Get_Protocol请求

Get_Protocol请求的作用是主机获取设备目前作用的是启动协议还是报表协议。 在数据阶段中设备回传的1个字节信息包中的数据值为0表示启动协议，为1表示报表协议。

启动设备必需支持该请求。

8.4.6 Set_Protocol请求

Set_Protocol的作用是主机指定设备使用启动协议或报表协议。

在数据阶段中主机传送的1个字节信息包中的数据值为0表示指定启动协议，为1表示指定报表协议。

启动设备必需支持该请求。

8.5 HID程序设计

HID设备是Windows系统提供了完善支持的一类，应用程序可以通过标准的API函数调用，实现与HID设备的通信。Windows系统提供了几千个API函数，作为应用程序与操作系统的接口，与HID相关的API函数被封装在hid.dll、setupapi.dll和kernal32.dll文件中。

8.5.1 HID访问使用的API函数

文件hid.dll中提供了很多个API，因为与HID设备通信有一定的复杂性。首先，在应用程序与HID传输数据之前，应用程序必须先识别该设备并且读取它的报表信息，这些动作需要调用多个API函数才可以实现。应用程序需要寻找连接到系统上的是哪些HID设备，然后读取每个设备的信息直到查找到所需的属性。如果是客户化的设备，应用程序可以寻找特定的厂商与产品ID，或者应用程序可以寻找特定类型的设备，例如键盘或鼠标。

第8章 USB接口HID设备 201

表8-11 用于HID设备的API函数 用于了解HID设备情况的API函数（hid.dll） HidD_GetAttributes 请求获得HID设备的厂商ID、产品ID和版本号 HidD_FreePreparsedData 释放函数HidD_GetPreparsedData所使用的资源 HidD_GetHidGuid 请求获得HID设备的GUID HidD_GetIndexString 请求获得由索引识别的字符串 HidD_GetManufactureString 请求获得设备制造商字符串 HidD_GetPhysicalDescriptor 请求获得设备实体字符串 HidD_GetPreparsedData 请求获得与设备能力信息相关的缓冲区的代号 HidD_GetProductString 请求获得产品字符串 HidD_GetSerialNumberString 请求获得产品序列号字符串 HidP_GetButtonCaps 请求获得HID报表中所有按钮的能力 HidP_GetCaps 请求获得用于描述设备能力的结构的指针 HidP_GetLinkCollectionNotes 请求获得描述在顶层集合中的连接集合（Link Collection）关系的结构的数组 HidP_GetSpecificButtonCaps 请求获得报表中按钮的能力，该请求可以设定一个Usage Page、Usage或是Link Collection HidP_GetSpecificValueCaps 请求获得报表中数值的能力，该请求可以设定一个Usage Page、Usage或是Link Collection HidP_GetValueCaps 请求获得HID报表中所有数值的能力 HidP_MaxUsageListLength 请求获得HID报表中可以回传的按钮的最大数目，该请求可以设定一个Usage Page HidP_UsageListDifference 比较两个按钮列表，并且求出在一个列表中设定而在另一个列表中没有设定的按钮 用于从设备读取、向设备传送报表的API函数（hid.dll） HidD_GetFeature 从设备读取一个特征报表 HidD_SetFeature 向设备传送一个特征报表 HidP_GetButtons 从设备读取包含每个按下的按钮的用法（Usage）的缓冲区的指针，该请求可以设定一个Usage Page HidP_GetButtonEx 从设备读取包含每个按下的按钮的Usage和Usage Page的缓冲区的指针 HidP_GetScaledUsageValue 从设备读取一个已经经过比例因子调整的有符号数值 HidP_GetUsageValue 从设备读取一个指向数值的指针 HidP_GetUsageValueArray 从设备读取包含多个数据项的Usage的数据 HidP_SetButtons 向设备传送设置按钮的数据 HidP_SetScaledUsageValue 将一个实际数值转换成设备使用的逻辑数值，并将其插入到报表中 HidP_SetUsageValue 向设备传送数据 HidP_SetUsageValueArray 向设备传送包含多个数据项的Usage的数据 HidD_FlushQueue 清空输入缓冲区 HidD_GetNumInputBuffer 获得驱动程序用于存储输入报表的环形缓冲区的大小，默认值是8 HidD_SetNumInputBuffer 设置驱动程序用于存储输入报表的环形缓冲区的大小 用于查找和识别设备的API函数（setupapi.dll） SetupDiGetClassDevs 获得HID的信息，针对已安装的设备，回传一个指向其信息集的代码 SetupDiEnumDeviceInterfaces 请求获得设备信息群内的一个设备的信息 SetupDiGetDeviceInterfaceDetail 请求获得设备的路径 SetupDiDestroyDeviceInfoList 释放SetupDiGetClassDevs使用的资源 用于打开、关闭设备和实现数据传送的API函数（kernal32.dll） CreatFile 取得设备的路径后，调用该函数获得设备代号 202 计算机高级接口实践 WriteFile 向设备传送输出报表 ReadFile 从设备读取输入报表 CloseHandle 关闭设备，释放CreateFile所使用的资源

8.5.2 查找HID的过程

在实现HID的访问之前，首先要查找指定（根据设备的厂商ID、产品ID和产品序列号）的HID。查找指定设备的过程如下：

? 调用函数HidD_GetHidGuid获得USB设备的GUID；

? 调用函数SetupDiGetClassDevs，获得一个包含全部HID信息的结构数组的指针，下面根据此数组逐项查找指定的HID；

? 调用函数SetupDiEnumDeviceInterfaces，填写SP_DEVICE_INTERFACE_DATA结构的数据项，该结构用于识别一个HID设备接口；

? 调用函数SetupDiGetDeviceInterfaceDetail，获得一个指向该设备的路径名； ? 调用函数CreateFile，获得设备句柄；

? 调用函数HidD_GetAttributes，填写HIDD_ATTRIBUTES结构的数据项，该结构包含设备的厂商ID、产品ID和产品序列号，比照这些数值确定该设备是否是查找的设备。

查找HID的流程如下图。

第8章 USB接口HID设备 203

开始 调用HidD_GetHidGuid获得GUID 调用SetupDiGetClassDevs获得全部HID信息 调用SetupDiEnumDeviceInterfaces获得特定HID识别信息 调用SetupDiGetDeviceInterfaceDetail获得特定HID路径名 调用CreateFile获得特定HID句柄 调用HidD_GetAttributes获得特定HID的厂商ID、产品ID 找到指定HID？ No No 查找完毕？ Yes 结束 Yes 图8-6 查找设备的流程

下面介绍VB实现的查找过程。 (1) 获得GUID

应用程序要与HID设备通信之前，必须先获得HID类别的GUID（Globally Unique Indentifer）。GUID是一个128位的数值，每个对象都有惟一的GUID。HID类别的GUID包含在hidclass.h文档内，可以接引用，或是使用 HidD_GetHidGuid函数来取得HID类别的 GUID。

? 函数声明 Public Declare Function HidD_GetHidGuid Lib \) As Long ? GUID结构说明 Public Type GUID Data1 As Long Data2 As Integer Data3 As Integer 204 计算机高级接口实践 Data4(7) As Byte End Type ? 变量说明 Dim HidGuid as GUID ? 调用 Call HidD_GetHidGuid(HidGuid) (2) 获得HID的结构数组

得到GUID后调用SetupDiGetClassDevs函数传回所有已经连接并且检测过的HID包含其信息的结构数组的地址。

? 函数声明

Public Declare Function SetupDiGetClassDevs Lib \\ ByRef ClassGuid As GUID, _ ByVal Enumerator As String, _ ByVal hwndParent As Long, _ ByVal Flags As Long) _ As Long ? 常量说明

Public Const DIGCF_PRESENT = &H2

Public Const DIGCF_DEVICEINTERFACE = &H10

? 调用

hDevInfoSet = SetupDiGetClassDevs( HidGuid, _ ?通过HidD_GetHidGuid函数获得GUID vbNullString, _ 0, _ (DIFCG_PRESENT or DIFCG_DEVICEINTERFACE) _ )

该函数的ClassGuid参数值为通过HidD_GetHidGuid函数获得GUID。Enumerator与hwndParent参数没有用到，Flags参数是两个定义在setupapi.h文档内的系统常数。代码中的Flags常数告诉SetupDiGetClassDevs函数只寻找目前存在（连接并且检测过）的设备接口，并且是HID类别的成员。

返回值hDevlnfoSet是包含所有连接并且检测到的全部HID的信息的结构数组的地址。在程序中并不需要访问hDevInfoSet的元素，只需要将hDevlnfSet值传给SetupDiEnumDeviceInterfaces函数即可。

当程序不再需要hDevInfoSet指向的数组时，应该调用 SetupDiDestroyDeviceInfo List函数来释放资源。

下面在hDevInfoSet指向的结构数组中查找。 (3) 识别HID接口

接下来调用SetupDiEnumDeviceInterfaces，填写SP_DEVICE_INTERFACE_DATA结构的数据项，该结构用于识别一个HID设备接口。

? 函数声明 Public Declare Function SetupDiEnumDeviceInterfaces Lib \ ByVal DeviceInfoSet As Long, _ 第8章 USB接口HID设备 205

ByVal DeviceInfoData As Long, _

ByRef InterfaceClassGuid As GUID, _ ByVal MemberIndex As Long, _

ByRef DeviceInterfaceData As SP_DEVICE_INTERFACE_DATA _ )As Long

? 结构定义

Public Type SP_DEVICE_INTERFACE_DATA cbSize As Long

InterfaceClassGuid As GUID Flags As Long Reserved As Long End Type

? 变量说明

Dim Result as Long

Dim MemberIndex as Long

Dim MyDeviceInterfaceData as SP_DEVICE_INTERFACE_DATA

? 调用

MyDeviceInterfaceData.cbSize = LenB(MyDeviceInterfaceData) MemberIndex = 0

Result = SetupDiEnumDeviceInterfaces( DeviceInfoSet, _ ?SetupDiGetClassDevs的返回值 0, _ HidGuid, _ ?通过HidD_GetHidGuid函数获得的GUID MemberIndex, _ ?第一次调用设置为0 MyDeviceInterfaceData _ )

参数cbSize是SP_DEVICE_INTERFACE_DATA结构的大小，以字节为单位。在调用SetupDiEnumDeviceInterfaces函数之前，cbSize必须储存在结构内来当做传递的参数。

参数HidGuid和DeviceInfoSet是函数之前的传回值。

DeviceInfoData是SP_DEVICE_INTERFACE_DATA结构的指针，用来限制检测特定设备的接口。MemberIndex是DeviceInfoSet数组的索引值，在遍历整个数组的循环中MemberIndex递增。MyDeviceInterfaceData是回传的结构，用来识别HID的一个接口。

(4) 获得设备路径

下面通过调用SetupDiGetDeviceInterfaceDetail函数用来获得另外一个结构：SP_DEVICE_INTERFACE_DETAIL_DATA。此结构与前一个函数SetupDiEnumDeviceInterfaces所识别的设备接口有关。结构的DevicePath成员是一个设备路径，应用程序可以用此路径来实现与该设备的通信。

? 函数声明： Public Declare Function SetupDiGetDeviceInterfaceDetail Lib \ Alias \ ByVal DeviceInfoSet As Long, _ ByRef DeviceInterfaceData As SP_DEVICE_INTERFACE_DATA, _ ByVal DeviceInterfaceDetailData As Long, _ ByVal DeviceInterfaceDetailDataSize As Long, _ ByRef RequiredSize As Long, _ ByVal DeviceInfoData As Long _ ) As Long

206 计算机高级接口实践

? 结构声明

Public Type SP_DEVICE_INTERFACE_DETAIL_DATA cbSize As Long

DevicePath As Byte End Type

? 变量定义

Dim Needed as Long, DetailData as long

Dim MyDeviceInterfaceDetailData As SP_DEVICE_INTERFACE_DETAIL_DATA Dim DetailDataBuffer() as Byte Dim DevicePathName As String

? 调用

MyDeviceInterfaceData.cbSize = LenB(MyDeviceInterfaceData)

Result = SetupDiGetDeviceInterfaceDetailA( DeviceInfoSet, _ DeviceInterfaceData, _ 0, _ 0, _ Needed, _ 0 _ )

DetailData = needed

MyDeviceInterfaceDetailData.cbSize = Len(MyDeviceInterfaceDetailData) ReDim DetailDataBuffer(Needed)

Call RtlMoveMemory(DetailDataBuffer(0), MyDeviceInterfaceDetailData, 4) Result = SetupDiGetDeviceInterfaceDetailA( DeviceInfoSet, _ DeviceInterfaceData, _ VarPtr(DetailDataBuffer(0)), _ DetailData, _ Needed, _ 0 _ )

? 转换成字符串，再转换成Unicode并从中删除4个字符得到设备路径 DevicePathName = Cstr(DetailDataBuffer())

DevicePathName = StrCovn(DevicePathName, vbUnicode)

DevicePathName = Right$(DevicePathName, Len(DevicePathName)-4)

DeviceInterfaceDetailDataSize包含DeviceInterfaceData结构的大小，以字节为单位。但是，在调用SetupDiGetDeviceInterfaceDetail函数之前无法知道此数值的大小，如果没有DeviceInterfaceDetailDataSize函数，SetupDiGetDeviceInterfaceDetail函数不会传回所需的结构。

这个问题的解决方式是两次调用SetupDiGetDeviceInterfaceDetail函数。第一次调用时GetLastError函数会传回错误信息，即：The data erea passed to a system call is too small，但是RequireSize参数会包含正确的DeviceInterfaceDetailDataSize数值。再次调用时传递此传回值，函数就会执行成功。

(5) 获得设备句柄

取得设备的路径以后，就可以准备开始与设备通信。使用CreateFile来打开一个HID设备，并且取得此设备的句柄，使用设备的句柄来与设备交换数据。当不再需要访问此设备时，应该调用CIoseHandle函数来关闭设备并释放系统资源。

第8章 USB接口HID设备 207

? 函数声明：

Public Declare Function CreateFile Lib \ ByVal lpFileName As String, _ ByVal dwDesiredAccess As Long, _ ByVal dwShareMode As Long, _

ByRef lpSecurityAttributes As Long, _ ByVal dwCreationDisposition As Long, _ ByVal dwFlagsAndAttributes As Long, _ ByVal hTemplateFile As Long _ ) As Long

? 常量定义

Public Const GENERIC_READ = &H80000000 Public Const GENERIC_WRITE = &H40000000 Public Const FILE_SHARE_READ = &H1 Public Const FILE_SHARE_WRITE = &H2 Public Const OPEN_EXISTING = 3

? 调用

HidDevice = CreateFile( _ DevicePathName, _

GENERIC_READ Or GENERIC_WRITE, _

(FILE_SHARE_READ Or FILE_SHARE_WRITE), _ 0, _

OPEN_EXISTING, _ 0, _ 0 )

(6) 获得设备的厂商ID、产品ID和产品序列号

要识别一个设备是否是所要的设备，只要比较此设备的厂商与产品ID 即可。

HidD_GetAttributes函数用来取得一个包含厂商与产品ID以及产品的版本号码的结构。

? 函数声明

Public Declare Function HidD_GetAttributes Lib \ByVal HidDeviceObject As Long, _

ByRef Attributes As HIDD_ATTRIBUTES _ ) As Long

? 结构说明

Public Type HIDD_ATTRIBUTES Size As Long

VendorID As Integer ?厂商ID ProductID As Integer ?产品ID VersionNumber As Integer ?产品版本号 End Type

? 变量定义

Dim DeviceAttributes As HIDD_ATTRIBUTES

? 调用

DeviceAttributes.Size = LenB(DeviceAttributes) Result = HidD_GetAttributes( _ HidDevice, _ ?由CreateFile函数返回 DeviceAttributes )

208 计算机高级接口实践 HidDevice是由 CreateFile函数所传回的设备句柄。如果CreateFile函数传回的是非零值，DeviceAttributes结构就会填写正确值。应用程序可以由DeviceAttributes结构取得厂商ID、产品ID以及产品的版本号码。

如果厂商与产品ID不是想查找的，应用程序应该使用CloseHandle函数来关闭该设备，然后移到下一个SetupDiEnumDeviceInterfaces所检测到的下一个HlD继续查找。当应用程序检测到指定的设备或是检测完全部HID，它应该调用

SetupDiDestroyDeviceInfoList函数来释放SetupDiGetClassDevs函数所保留的资源。

8.5.3 获得HID的能力

获得设备的能力是可以进一步了解HID的手段，但不是必须的。如果在查找设备时，如果通过厂商ID、产品ID和产品序列号可以确定特定的设备，一般是已知设备的细节信息了。如果不通过厂商ID、产品ID和产品序列号确定设备，另一个方法是通过获得设备能力来确定设备。

获得HID的能力的过程主要经过以下几个步骤：

? 先使用HidD_GetPreparsedData函数获得一个包含设备能力信息的缓冲区的指

针，调用HidP_GetCaps获得描述HID的能力的数据结构； ? 调用HidP_GetValueCaps取得描述能力的数值。 (1) 获得描述HID能力的数据结构

? 函数声明 Public Declare Function HidD_GetPreparsedData Lib \ ByVal HidDeviceObject As Long, _ ByRef PreparsedData As Long ) As Long ? 变量定义 Dim PreparsedData As Long ? 调用 Result = HidD_GetPreparsedData (HidDevice, _ ? 由CreateFile获得的设备句柄 PreparsedData _ ) PreparsedData是一个包含数据的缓冲区的指针。程序并不需要访问缓冲区内的数据，只需要将缓冲区的开始地址传递给其他的API函数。当应用程序不再需要PreparsedData时，它应该调用HidD_FreePreparsedData函数来释放系统资源。

接下来调用HidP_GetCaps，该函数传回一个结构，里面包含设备能力的信息，包括设备的Usage Page、Usage、报表长度以及按钮能力和数值能力等的数目。如果不使用厂商与产品ID来识另设备，HidP_GetCaps函数传回的设备能力信息可以帮助决定是否继续与此设备通信。

? 函数声明 Public Declare Function HidP_GetCaps Lib \ ByVal PreparsedData As Long, _ ByRef Capabilities As HIDP_CAPS ) As Long ? 结构定义 Public Type HIDP_CAPS 第8章 USB接口HID设备 209

Usage As Integer ? 用法 UsagePage As Integer ? 用法页 InputReportByteLength As Integer ? 输入报表长度 OutputReportByteLength As Integer ? 输出报表长度 FeatureReportByteLength As Integer ? 特征报表长度 Reserved(16) As Integer

NumberLinkCollectionNodes As Integer ? 由函数HidP_GetLinkCollectionNodes ? 返回的顶层集合连接数目 NumberInputButtonCaps As Integer ? 由函数HidP_GetButtonCaps返回的

? 包含输入按钮能力的结构HIDP_BUTTON_ ? CAPS的数目 NumberInputValueCaps As Integer ? 由函数HidP_GetValueCaps返回的

? 包含输入数值能力的结构HIDP_VALUE_ ‘ CAPS的数目 NumberInputDataIndices As Integer ? 在输入报表中有关按键和数值的数据

? 指示器（Data Indices）的数目 NumberOutputButtonCaps As Integer ? 由函数HidP_GetButtonCaps返回的

? 包含输出按钮能力的结构HIDP_BUTTON_ ? CAPS的数目 NumberOutputValueCaps As Integer ? 由函数HidP_GetValueCaps返回的

? 包含输出数值能力的结构HIDP_VALUE_ ‘ CAPS的数目 NumberOutputDataIndices As Integer ? 在输出报表中有关按键和数值的数据 ? 指示器（Data Indices）的数目 NumberFeatureButtonCaps As Integer ? 由函数HidP_GetButtonCaps返回的

? 包含特征按钮能力的结构HIDP_BUTTON_ ? CAPS的数目 NumberFeatureValueCaps As Integer ? 由函数HidP_GetValueCaps返回的

? 包含特征数值能力的结构HIDP_VALUE_ ‘ CAPS的数目 NumberFeatureDataIndices As Integer ? 在特征报表中有关按键和数值的数据 ? 指示器（Data Indices）的数目 End Type

? 变量定义

Dim Capabilities As HIDP_CAPS

? 调用

Result = HidP_GetCaps (_ PreparsedData, _ ? 由函数HidD_GetPreparsedData定义 Capabilities )

HidP_GetCaps函数填写Capabilities结构中的数据项，Capabilities结构成员说明了HID的基本信息。这些信息包括：

? 用法页和用法：UsagePage、Usage；

? 输入、输出和特征报表长度：InputReportByteLength、

OutputReportByteLength和 FeatureReportByteLength；

? 由函数HidP_GetLinkCollectionNodes返回的顶层集合连接数目

NumberLinkCollectionNodes

? 在输入、输出和特征报表的按钮、数值和数据指示器的的数目。

210 计算机高级接口实践

(2) 获得描述HID数值能力的数据结构

通过HidP_GetCaps获得的HID的基本能力信息不是能从设备得到全部信息，还可以调用另一个函数HidP_GetValueCap，该函数可以获得报表描述符中的数值和按钮的能力。HidP_GetValueCap返回的是包含了报表描述符中全部数值信息的结构的指针。

? 函数声明

Public Declare Function HidP_GetValueCaps Lib \ ByVal ReportType As Integer, _ ByRef ValueCaps As Byte, _ ByRef ValueCapsLength As Integer, _ ByVal PreparsedData As Long _ ) As Long

? ReportType常量定义

Public Const HidP_Input = 0 Public Const HidP_Output = 1 Public Const HidP_Feature = 2

Public Type HidP_Value_Caps UsagePage As Integer ReportID As Byte IsAlias As Long BitField As Integer LinkCollection As Integer LinkUsage As Integer LinkUsagePage As Integer IsRange As Long IsStringRange As Long IsDesignatorRange As Long IsAbsolute As Long HasNull As Long Reserved As Byte BitSize As Integer ReportCount As Integer Reserved2 As Integer Reserved3 As Integer Reserved4 As Integer Reserved5 As Integer Reserved6 As Integer LogicalMin As Long LogicalMax As Long PhysicalMin As Long PhysicalMax As Long UsageMin As Integer UsageMax As Integer StringMin As Integer StringMax As Integer DesignatorMin As Integer DesignatorMax As Integer DataIndexMin As Integer DataIndexMax As Integer End Type

? 变量定义

Dim ValueCaps(1023) As Byte ? 调用

Result = HidP_GetValueCaps (_ HidP_Input, _

第8章 USB接口HID设备 211 ValueCaps(0), _ Capabilities.NumberInputValueCaps, _ PreparsedData ) (3) 输出报表到设备

当应用程序取得HID设备的句柄，并且知道输出报表的字节数目后，它就可以传送输出报表给此设备。应用程序先将要传送的数据复制到一个缓冲区内，然后调用WriteFile函数。缓冲区的大小等于HidP_GetCaps函数返回的HIDP_CAPS结构的OutputReportByte Length属性值。这个大小值等于报表的字节大小，再加上一个字节的Report ID。Report ID是缓冲区的第一个字节。

HlD驱动程序用来确定输出报表的传输类型，根据Windows的版本以及HID接口有无中断输出端点而定。应用程序不需要干预，低阶的驱动程序会自动处理。

? 函数声明

Public Declare Function WriteFile Lib \ ByVal hFile As Long, _ ByRef lpBuffer As Byte, _ ByVal nNumberOfBytesToWrite As Long, _ ByRef lpNumberOfBytesWritten As Long, _ ByVal lpOverlapped As Long _ ) As Long

? 变量定义

Dim SendBuffer() As Byte

Dim OutputReportData(7) As Byte Dim Count as Long

? 调用

ReDim SendBuffer(Capabilities.OutputReportByteLength - 1) SendBuffer(0) = 0 ? Report ID

? 将准备的数据从OutputReportData复制到SendBuffer

For Count = 1 To Capabilities.OutputReportByteLength - 1 SendBuffer(Count) = OutputReportData(Count - 1) Next Count

NumberOfBytesWritten = 0 Result = WriteFile( _ HidDevice, _ ? 由CreateFile函数返回的设备句柄 SendBuffer(0), _ ? 输出报表缓存 CLng(Capabilities.OutputReportByteLength), _ ? 要输出字节数 NumberOfBytesWritten, _ ? 实际输出的字节数

0 )

如果函数返回的Result数值不等于零，表示函数成功执行。

如果接口只支持数值为0的Report ID，这个Report ID并不传送，但需要出现在应用程序传给WriteFile函数的缓冲区内。

WriteFile函数在HID通信中最常发生的错误是CRC error。此错误表示主机控制器试图要传送报表，但是没有从设备收到预期的响应。通常该错误不是发生在CRC计算时所检测到的错误，而是因为主机没有收到固件预期的响应。

(4) 从设备输入出报表

当应用程序取得HID设备的句柄，并且知道输入报表的字节数目后，就可以从此设备读取输入报表。应用程序先声明一个缓冲区来储存数据，然后调用ReadFile函数。用来储

212 计算机高级接口实践

存数据的缓冲区大小等于HidP_GetCaps函数所返回的HIDP_CAPS结构的InputReport

ByteLength属性值。

? 函数声明

Public Declare Function ReadFile Lib \ ByVal hFile As Long, _ ByRef lpBuffer As Byte, _ ByVal nNumberOfBytesToRead As Long, _ ByRef lpNumberOfBytesRead As Long, _ ByVal lpOverlapped As Long _ ) As Long

? 变量定义 Dim Count

Dim NumberOfBytesRead As Long Dim ReadBuffer() As Byte ? 输入缓冲区，字节0为Report ID ReDim ReadBuffer(Capabilities.InputReportByteLength - 1)

? 调用

Result = ReadFile( _ HidDevice, _ ? 由CreateFile函数返回的设备句柄 ReadBuffer(0), _ ? 输入缓冲区首地址 CLng(Capabilities.InputReportByteLength), _ ? 要读取的字节数 NumberOfBytesRead, _ ? 读到的字节数

0 )

ReadBuffer字节数组包含报表的数据。如果函数返回的Result数值不等于零，表示函数成功执行。

通过ReadFile读取的缓冲区的第一个字节是Report ID，后续是从设备读取的报表数据。如果接口只支持一个Report ID，此Report ID不在总线上传输，但会出现在ReadBuffer缓冲区内。

调用ReadFile函数不会立刻开始总线上的传输，只是主机在定时的中断输入传输中读取一个报表。如果没有未读取的报表，就等待下一个传输完成。主机在检测设备后开始请求报表，当HlD驱动程序加载后，驱动程序将报表储存在环状缓冲区内。当缓冲区已经填满并有新的报表到达时，旧的报表会被覆盖。调用ReadFile函数会读取缓冲区内最旧的报表。

在Windows 98 SE以及后来的版本中，默认的环状缓冲区尺寸是8个报表。应用程序可以使用HidD_SetNumInputBuffers函数来设置缓冲区的大小。如果应用程序没有频繁的请求报表，有些报表就会丢失。如果不想要丢失报表，就应该改用特征报表。

如果报表的数据从上一次传输后就没有改变，闲置速率决定设备是否要传送报表。在检测设备时HlD驱动程序会试图将设备的闲置速率设置为0，这表示除非报表的数据有改变否则HID不会传送报表。没有可以改变闲置速率的API函数。

如果设备拒绝将闲置速率设置为0，可以传回Stall来响应Set_Idle请求来通知主机设备不支持该请求。

如果设备不支持Set_Idle请求，而且应用程序只要读取一次报表，固件可以设置成只传送一次报表。在送报表后，固件可以设置端点传回NAK来响应输入令牌信息包。如果设备有新的数据要传送，固件可以设置端点来传回该数据。否则设备会在主机轮询端点时继续传送相同的报表，应用程序也会重复地读取相同的报表。

第8章 USB接口HID设备 213

上面程序中ReadFile的最后一个参数为0，表示ReadFile调用是阻塞的。当应用程序在环形缓冲区为空时调用ReadFile，应用程序将会被挂起，直到有输入报表为止，否则只能按下Ctrl＋Alt＋Del来关闭应用程序，或是从总线上移除设备。

采用多线程方式编程可以较好的解决这个问题，在另一个线程中调用ReadFile可以避免主线程被挂起，在使用Visual Basic编写多线程应用程序会遇到困难，这是因为Visual Basic本身不支持多线程。而在Visual C++编写API方式通信程序时可以采用多线程方式，ReadFile函数调用发生在一个独立的线程，这样可以实现重叠I/O操作。

解决的办法之一是保证设备永远有数据传送，可以将固件设计为输入端点永远启用并且准备响应要求。如果没有新的数据传送，设备可以传送上一次的数据，或是传回一个特定代码来指示没有新的数据。

也可以采用这样的方法，在调用ReadFile之前，应用程序先调用WriteFile来传送一个报表，报表内可以包含一个特定代码来告诉固件准备传送数据，这样当应用程序调用ReadFile时，设备的端点就会启用并且有数据准备传送。

比较好的方法是使用ReadFile的重叠选项。在重叠的读取时ReadFile函数会立即返回（即使没有可读数据），然后应用程序调用 WaitForSingleObject函数来读取数据。WaitForSingleObject函数可以设置暂停，如果数据在指定时间内尚未抵达，此函数会传回一个码来指示此情况，然后应用程序可以使用CancelIo函数来取消读取动作。

要使用重叠I/O，CreateFile函数必须在dwFlagsAndAttributes参数中传递一个重叠的结构。应用程序调用CreateEvent函数建立一个事件对象，在ReadFile完成后此事件对象会被设置成信号状态。当应用程序调用ReadFile时，它传递一个重叠结构的指针，重叠结构的hEvent参数是一个事件对象的代号。应用程序调用 WaitForSingleObject函数来传递此事件代号，以及一个以ms为单位的指定时间间隔。在读取到数据或到达该时间间隔时，此函数才返回。

? 函数声明

Public Declare Function ReadFile Lib \ ByVal hFile As Long, _ ByRef lpBuffer As Byte, _ ByVal nNumberOfBytesToRead As Long, _ ByRef lpNumberOfBytesRead As Long, _ ByVal lpOverlapped As Long _ ) As Long

Public Declare Function CreateEvent Lib \ ByVal SecurityAttributes As Long, _ ByVal bManualReset As Long, _ ByVal bInitialState As Long, _ ByVal lpName As String ) As Long

Public Declare Function WaitForSingleObject Lib “kernal32.dll” (_ ByVal hHandle as Long, _ ByVal dwMilliseconds as Long ) as Long

? 重叠结构声明

Public Type OVERLAPPED Internal as Long InternalHigh as Long Offset as Long OffsetHigh as Long hEvent as Long

214 计算机高级接口实践 End Type

? 常量定义

Public Const FILE_FLAG_OVERLAPPED = &H40000000

? 变量定义

Dim EventObject as Long

Dim HIDOverlapped as OVERLAPPED

? 部分代码

EventObject = CreatEvent (0&, True, True, “”) HIDOverlapped.hEvent = EventObject HIDOverlapped.Offset = 0

HIDOverlapped.OffsetHigh = 0

HidDevice = CreateFile( _ DevicePathName, _

GENERIC_READ Or GENERIC_WRITE, _

(FILE_SHARE_READ Or FILE_SHARE_WRITE), _ 0, _

OPEN_EXISTING, _ FILE_FLAG_OVERLAPPED, _ 0

) ? 获得HID设备句柄

Result = ReadFile( _ HidDevice, _ ? 由CreateFile函数返回的设备句柄 ReadBuffer(0), _ ? 输入缓冲区首地址 CLng(Capabilities.InputReportByteLength), _ ? 要读取的字节数 NumberOfBytesRead, _ ? 读到的字节数

HIDOverlapped

) ? 读取报表，同时传送一个指针到重叠结构

Result = WaitForSingleObject (EventObject, 5000) ? 等待ReadFile完成，超时间隔设为5秒

(5) 特征报表的传送

应用程序调用HidD_SetFeature函数传送一个特征报表到设备。

? 函数声明 Public Declare Function HidD_SetFeature Lib \ ByVal HidDeviceObject As Long, _ ByRef ReportBuffer As Byte, _ ByVal ReportBufferLength As Long ) As Long ? 调用 Result = HidD_SetFeature( _ HidDevice, _ ? 由CreateFile函数返回的设备句柄 SendBuffer(0), _ ? 输出缓冲区首地址 CLng(Capabilities.FeatureReportByteLength) ? 特征报表长度字节数 ) 第8章 USB接口HID设备 215

API函数HidD_GetFeature用于从设备读取特征报表，通过对该API函数的调用，主机控制器以控制传输送出Get_Feature请求，并在数据阶段，设备回传特征报表。

? 函数声明 Public Declare Function HidD_GetFeature Lib \ ByVal HidDeviceObject As Long, _ ByRef ReportBuffer As Byte, _ ByVal ReportBufferLength As Long ) As Long ? 调用 Result = HidD_GetFeature( _ HidDevice, _ ? 由CreateFile函数返回的设备句柄 ReadBuffer(0), _ ? 输出缓冲区首地址 CLng(Capabilities.FeatureReportByteLength) ? 特征报表长度字节数 ) (6) 关闭设备

当结束与HID的通信，需要调用CloseHandle函数关闭通信

? 函数声明 Public Declare Function CloseHandle Lib \ ByVal hObject As Long _ ) As Long ? 调用 Result = CloseHandle(HidDevice) 8.6 HID实验

本节介绍通过高级接口实验台进行的一个HID编程实验。

在USB设备软件的开发过程中，借助于一些工具软件的测试会对USB设备的信息获取和通信过程又更深入的理解。USB测试软件有很多，如USBView、BusHound等，下面针对一个具体的HID设备的API通信软件的开发，对这两个工具软件作一简单介绍。

高级接口实验台中，有一个HID实验，在该实验中，实验台通过固件软件设计了一个简单的HID仿真设备，在PC的API通信软件的开发过程中，可以借助USB工具软件对实验台的HID设备进行测试。

8.6.1 获得描述符

将高级接口实验台通过USB电缆与PC连接后，在实验台上通过菜单选择HID实验，实验台显示器显示器上会显示HID实验界面。

实验台的HID实验是一个为了学习HID编程而专门设计的一个简单的HID仿真设备，设备中设计了8个寄存器（R1~R8），可以通过USB接口与主机交换数据。其中R1和R2两个寄存器只是数据存储单元，主机可以对这两个寄存器进行附值，也可以读取寄存器的值。寄存器R3~R8构成了一个日期和时钟，6个寄存器的值分别表示年、月、日、时、分、秒。时钟在当前值的基础上运行，可以通过主机对时钟进行设置，也可以读取当前的时钟值。

在实验台上设计了自动回传功能，如果自动回传打开，时钟每一秒向主机传送一次报

216 计算机高级接口实践

表。实验台可以显示发送和接收的有效数据字节数。

==========USB接口传输控制实验========== 寄存器 R1：00000000 = 00H R2：00000000 = 00H 时钟 00 年 01 月 01 日 00 点 00 分 00 秒 R3 R4 R5 R6 R7 R8 时钟自动回传：关闭 USB:控制模式 传输计数：收0000 发0000 中断 打开 计数 结束 进入 回传 清零 实验 图8-7 高级接口实验台HID实验界面

USBView是Microsoft提供的一个简单的USB测试软件，该工具软件是一个完全的绿色软件，只有一个EXE程序文将，不需要安装，在Windows环境下直接运行。

USBView其主要功能是获得USB设备的各个描述符。

可以运行USBView获得实验台仿真的HID设备的描述符，运行USBView后显示以下程序界面。

图8-8 USBView运行界面

窗口的左侧显示全部的USB设备连接树，在其中找到一个显示“USB人体工程学设备”的分支，选中后右侧窗口显示全部的（报表描述符除外）描述符。USBView显示的高级接口实验台的HID仿真设备的描述符如下。

Device Descriptor: bcdUSB: bDeviceClass: 0x0110 0x00 bDeviceSubClass: bDeviceProtocol: bMaxPacketSize0: idVendor: idProduct: bcdDevice: iManufacturer: iProduct: iSerialNumber: bNumConfigurations:

ConnectionStatus: DeviceConnected Current Config Value: 0x01 Device Bus Speed: Full Device Address: 0x02 Open Pipes: 4

Endpoint Descriptor: bEndpointAddress: 0x81 Transfer Type: Bulk wMaxPacketSize: 0x0010 (16) bInterval: 0x0A

Endpoint Descriptor: bEndpointAddress: 0x01 Transfer Type: Bulk wMaxPacketSize: 0x0010 (16) bInterval: 0x0A

Endpoint Descriptor: bEndpointAddress: 0x82 Transfer Type: Interrupt wMaxPacketSize: 0x0040 (64) bInterval: 0x01

Endpoint Descriptor: bEndpointAddress: 0x02 Transfer Type: Interrupt wMaxPacketSize: 0x0040 (64) bInterval: 0x01

第8章 USB接口HID设备 217 0x00 0x00 0x10 (16) 0x045E (Microsoft Corporation) 0x930A 0x0100 0x01 0x02 0x03 0x01

8.6.2 设备的初始化

在将高级接口实验台连接到计算机并操作实验台进入HID接口实验后，Windows系统会发现设备并读取设备的各种描述符，可以通过一个USB工具软件截取Windows和设备之间的请求应答过程。工具软件BusHound可以实现这个功能。

BunHound是一个功能全面的总线分析仪软件，可以实现对计算机通过各种接口连接的设备的通信过程进行截取和分析。图8-9是BusHound的设备连接树（Devices）界面。

当高级接口实验台与计算机通过USB接口连接并操作实验台进入HID实验，可以在BusHound的设备连接树中找到一个“USB人体工程学设备”项目。选中该项目可以实现对设备的通信过程的截取。

选中高级接口实验台的HID设备项，进入到采集（Capture）界面，先控制实验台退出HID实验，按BusHound的采集界面的Stop按钮，再按Run按钮，然后控制实验台进入HID实验界面。Windows系统发现设备并请求设备的各种描述符，然后完成对设备的必要的设置，BusHound可以采集到以上通信过程。

218 计算机高级接口实践

图8-9 BusHound的设备树显示界面

图8-10 BusHound的采集显示界面

第8章 USB接口HID设备 219

下面分析BusHound截取的数据内容。 ? 主机发送：80 06 00 01 00 00 12 00 Get_Descriptor请求，请求设备回传设备描述符。

? 设备发送：12 01 10 01 00 00 00 10 5e 04 0a 93 00 01 01 02 03 01 设备描述符内容：USB版本=1.1、类别/协议码=0、EP0的最大包尺寸=10、

VID=045E、PID=930A、版本=1.0、厂商、产品和序列号字符串索引、配置数=1。 ? 主机发送：80 06 00 02 00 00 09 00

Get_Descriptor请求，请求设备回传配置描述符。 ? 设备发送：09 02 37 00 01 01 04 80 32

配置描述符内容：该描述符及后续描述符总长度=55、支持接口数=1、配置标示符=1、总线供电、最大100mA。 ? 主机发送：80 06 00 02 00 00 37 00

Get_Descriptor请求，请求设备回传配置、接口、HID和端点描述符。

? 设备发送：09 02 37 00 01 01 04 80 32 09 04 00 00 04 03 00 00 05 09 21 01 01 00

01 22 34 00 07 05 81 02 10 00 0a 07 05 01 02 10 00 0a 07 05 82 03 40 00 01 07 05 02 03 40 00 01 按顺序为： 9字节配置描述符：含义同上。

9字节接口描述符：标示符=0、支持的端点=4、类别=HID。

9字节HID描述符：版本=1.01、有1个报表描述符（长度为52） 7字节端点描述符：1号批量输入，包尺寸=16。 7字节端点描述符：1号批量输出，包尺寸=16。

7字节端点描述符：2号中断输入，包尺寸=64、1ms轮询。 7字节端点描述符：2号中断输出，包尺寸=64、1ms轮询。 ? 主机发送：00 09 01 00 00 00 00 00

Set_Configuation请求，配置号=1。 ? 主机发送：21 0a 00 00 00 00 00 00 Set_Idle请求，设定间隔时间为0。 ? 设备发送：04 00 00 c0

STALL，不支持请求。

? 主机发送：81 06 00 22 00 00 74 00

Get_Descriptor请求，请求设备回传报表描述符。

? 设备发送：06 a0 ff 09 01 a1 01 09 02 a1 00 06 a1 ff 09 03 09 04 15 80 25 7f 35 00

45 ff 75 08 95 40 81 02 09 05 09 06 15 80 25 7f 35 00 45 ff 75 08 95 40 91 02 c0 c0 报表描述符。

8.6.3 HID测试程序的实现

使用Visual Basic编写一个针对高级接口实验台的应用程序，实现与设备的通信。该测试程序实现以下功能：

? 查找设备：根据指定的VID和PID实现设备查找； ? 获得设备能力：调用相应的API，获得设备的能力；

? 发送报表：将界面输入的R1~R8的数值按照报表的指定格式传送到设备； ? 接收报表：将设备的界面显示的R1~R8的数值读取到应用程序； ? 显示API函数调用信息：显示每一个API函数的调用结果； ? 关闭设备。

220 计算机高级接口实践

下图是程序运行的界面显示。

图8-11 针对实验台的HID测试程序显示界面

在获得能力的API函数的调用结果中，输入报表和输出报表的长度为65字节，在发送和接收报表时的长度设定都需要设为65。但在该实验中真正用到的有效数据只有8个寄存器的数据，占用其中的8个字节，报表的首字节（第0个）为0，表示Report ID。第1、2个字节分别55h、AAh为用户定义的标示字。第3、4字节为用户定义命令编码，输出报表中为01、08，输入报表中为02、08。从第5到第12字节顺序为R1、R2、…R8的值。之后的数据为保留字节。 'HID查找、能力检测、输入报表、输出报表演示程序 '修改自许永和的《介面设计与实习 使用Bisual Basic》 Option Explicit '变量定义 ****************************************************************************** Dim Capabilities As HIDP_CAPS Dim DataString As String Dim DetailData As Long Dim DetailDataBuffer() As Byte Dim DeviceAttributes As HIDD_ATTRIBUTES Dim DevicePathName As String Dim DeviceInfoSet As Long Dim ErrorString As String Dim HidDevice As Long

226 计算机高级接口实践 Dim NumberOfBytesWritten As Long Dim SendBuffer() As Byte

ReDim SendBuffer(Capabilities.OutputReportByteLength - 1)

'填写报表数据到数组SendBuffer Count = 0

SendBuffer(Count) = 0 '第一個位元組是Report ID Count = Count + 1

SendBuffer(Count) = &H55 Count = Count + 1

SendBuffer(Count) = &HAA Count = Count + 1

SendBuffer(Count) = &H1 Count = Count + 1

SendBuffer(Count) = &H8 Count = Count + 1

SendBuffer(Count) = Val(\Count = Count + 1

SendBuffer(Count) = Val(\Count = Count + 1

SendBuffer(Count) = Val(txtYear.Text) Count = Count + 1

SendBuffer(Count) = Val(txtMonth.Text) Count = Count + 1

SendBuffer(Count) = Val(txtDay.Text) Count = Count + 1

SendBuffer(Count) = Val(txtHour.Text) Count = Count + 1

SendBuffer(Count) = Val(txtMinute.Text) Count = Count + 1

SendBuffer(Count) = Val(txtSecond.Text) Count = Count + 1

'调用 WriteFile 函数,发送报表

NumberOfBytesWritten = 0

Result = WriteFile(HidDevice, SendBuffer(0), CLng(Capabilities.OutputReportByteLength), NumberOfBytesWritten, 0)

Call DisplayResultOfAPICall(\

lstResults.AddItem \ Output Report\End Sub

'************************************************************************************** '从HID读取报表

'注意：以下代码为非重叠调用，必须保证HID输出报表

'**************************************************************************************

Private Sub cmdReceive_click()

Dim Count

Dim NumberOfBytesRead As Long Dim ReadBuffer() As Byte

ReDim ReadBuffer(Capabilities.InputReportByteLength - 1)

'调用 ReadFile 函数，读取报表

Result = ReadFile(HidDevice, ReadBuffer(0), CLng(Capabilities.InputReportByteLength), NumberOfBytesRead, 0)

Call DisplayResultOfAPICall(\

lstResults.AddItem \ Input Report\

第8章 USB接口HID设备 227

'将输入报表的数据填写到显示介面的相应数据域 txtR1.Text = Hex$(ReadBuffer(5)) txtR2.Text = Hex$(ReadBuffer(6))

txtYear.Text = IIf(ReadBuffer(7) < 10, \txtMonth.Text = IIf(ReadBuffer(8) < 10, \txtDay.Text = IIf(ReadBuffer(9) < 10, \txtHour.Text = IIf(ReadBuffer(10) < 10, \txtMinute.Text = IIf(ReadBuffer(11) < 10, \txtSecond.Text = IIf(ReadBuffer(12) < 10, \End Sub

'************************************************************************************** '关闭设备，释放资源

'**************************************************************************************

Private Sub cmdClose_Click()

'调用 CloseHandle 关闭HID

Result = CloseHandle(HidDevice)

Call DisplayResultOfAPICall(\

'调用 SetupDiDestroyDeviceInfoList和HidD_FreePreparsedData 释放占用的资源

Result = SetupDiDestroyDeviceInfoList(DeviceInfoSet) Call DisplayResultOfAPICall(\Result = HidD_FreePreparsedData(PreparsedData)

Call DisplayResultOfAPICall(\

lstResults.Clear

cmdClose.Enabled = False cmdGetCaps.Enabled = False cmdTrans.Enabled = False cmdReceive.Enabled = False lblHID.Caption = \lblCaps.Caption = \

txtVendorID.Enabled = True txtProductID.Enabled = True End Sub

'************************************************************************************** '将当前日期和时间填写到界面的数据域

'**************************************************************************************

Private Sub cmdNow_Click()

txtHour.Text = IIf(Hour(Now()) < 10, \

txtMinute.Text = IIf(Minute(Now()) < 10, \txtSecond.Text = IIf(Second(Now()) < 10, \

txtYear.Text = IIf((Year(Now()) - 2000) < 10, \txtMonth.Text = IIf(Month(Now()) < 10, \txtDay.Text = IIf(Day(Now()) < 10, \End Sub

'************************************************************************************** '获得信息字符串

'**************************************************************************************

228 计算机高级接口实践 Private Function GetDataString(Address As Long, Bytes As Long) As String Dim Offset As Integer Dim Result$ Dim ThisByte As Byte For Offset = 0 To Bytes - 1 Call RtlMoveMemory(ByVal VarPtr(ThisByte), ByVal Address + Offset, 1) If (ThisByte And &HF0) = 0 Then Result$ = Result$ & \ End If Result$ = Result$ & Hex$(ThisByte) & \Next Offset GetDataString = Result$ End Function

本文来源：https://www.bwwdw.com/article/txfr.html