报表描述符定义了执行设备功能的数据格式和使用方法。
报表描述符和 USB 的其他描述符是不一样的,它不是一个简单的表格, 报表描述符是 USB 所有描述符中最复杂的 。报表描述符非常复杂而有弹性,因为它需要处理各种用途的设备。报表的数据必须以简洁的格式来储存,这样才不会浪费设备内的储存空间以及数据传输时的总线时间。
实际上可以这样理解, 报表内容的简洁,是通过报表描述符全面的、复杂的数据描述实现的 。
报表描述符必须先描述数据的大小与内容。报表描述符的内容与大小因设备的不同而不同,在进行报表传输之前,主机必须先请求设备的报表描述符,只有得到了报表描述符才可正确解析报表的数据。
报表描述符是报表描述项目( Item )的集合,每一个描述项目都有相对统一的数据结构,项目很多,通过编码实现。
(1)项目
报表描述符由描述 HID 设备的数据 项目(Item ) 组成。
项目的 第一个字节 (项目前缀)由三部分构成:
- 项目标志( item Tag ):说明项目的功能,
- 项目类型( item Type ):说明项目的数据类型,
- 项目长度( item Size ):说明项目的数据部分的长度。
HID 的项目有短项目和长项目两种,其中短项目的格式如下图。
短项目的数据字节数由 bSize 的值定义, bSize 为 0、 1、 2、 3 时 Data 部分的字节数分别为 0、 1、 2、 4 个字节。 (nn 为数据长度)短项目的项目类型由 bType 定义, bType 为 0、 1、 2 时分别为 Main 、 Global 和 Local类型。
长项目可以携带较多的数据,其格式如下图。
项目中的第一个字节为上图中的 特定值 时表明该项目是一个 长项目 。长项目中的bDataSize 说明 Data 部分的字节数, bLongItemT ag 在 HID 规范中没有定义。
下面是通过汇编实现的一个简单的报表描述符,描述符的每一行是一个项目,该描述符描述了一个 从设备接收 2 个字节的输入报表 和发送 2 个字节到设备的输出报表 。
(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 项目。
2.1 Main项
Main item tag | One-Byte Prefix (nn represents size value) | Valid Data | |
Input | 1000 00 nn | Bit 0 |
- 所有Main项的默认数据值为零(0)。
- 输入项的数据大小可以为零(0)字节。 在这种情况下,可以假定项目的每个数据位的值为零。 这在功能上与使用item标记完全相同,该标记指定4字节数据项,后跟4个零字节。
2.2 Input、Output和Feature项目
输入,输出和功能项用于在报表中创建数据字段。
- 输入项描述有关由一个或多个物理控件提供的数据的信息。 应用程序可以使用此信息来解释设备提供的数据。 在单个项目中定义的所有数据字段共享相同的数据格式。一个输入报表包含一个或多个 Input 项目,主机使用中断输入传输来请求输入报表。
- 输出项用于在报告中定义输出数据字段。 一个输出报表包含一个或多个 Outpot项目。 输出报表包含控制状态的数据。此项类似于输入项,除了它描述发送到设备的数据 - 例如,LED状态。
- 功能项描述可以发送到设备的设备配置信息。主机使用 Set_Report 与 Get_Report 请求来传送与接收特征报表。
在每一个 Input 、 Output 和 Feature 项目的前缀字之后是 32 位描述数据,目前最多定义了 9 个位,余的位则是保留。位 0~8 的定义中只有位 7 不能应用于 Input 项目,除此之外其他的位定义都适应于 Input 、 Output 和 Feature 项目。
位 | 参数 | 值 | 功能描述 |
0 | Data | Constant | 0 | 1 | 数据表明该项目正在定义包含可修改设备数据的报告字段。 |
- 当没有声明数组中的控件时,Array字段返回0值。
- 逻辑最小值等于1。
- 逻辑最大值等于数组中的元素数。
- 输入项定义可通过Control管道访问的输入报告,其中包含Get_Report(输入)请求。
- 输入类型报告也通过中断输入管道以轮询速率发送。
- 数据|常数,变量|数组,绝对|相对,非线性,自动换行和空状态数据与输入项的数据相同。
- 输出项目使用Set_Report(输出)命令通过控制管道访问输出报告。
- 输出类型报告可以选择通过中断输出管道发送。虽然功能相似,但输出和功能项目在以下方面有所不同:
- 功能项定义设备的配置选项,通常由控制面板应用程序设置。 由于它们会影响设备的行为(例如,按钮重复率,重置原点等),因此软件应用程序通常不会看到要素项。 相反,输出项表示向用户输出的设备(例如,LED,音频,触觉反馈等)。 软件应用程序可能会设置设备输出项。
- 功能项可以是其他项的属性。 例如,原点重置特征可以应用于一个或多个位置输入项。 与输出项类似,功能项组成功能报告可通过控制管道访问Get_Report(Feature)和Set_Report(Feature)请求。
2.2 Collection 和 End Collection 项目
Collection项标识两个或多个数据(输入,输出或特征)之间的关系。例如,鼠标可以描述为两到四个数据(x,y,按钮1,按钮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 。在设备报告多个传感器的位置的时候,使用 PhysicalCollection 指明不同的数据来自不同的传感器。Logical Collection 形成一个数据结构,包含由 Collection 所连结的不同类型的项目。例如数据缓冲区的内容以及缓冲区内字节数目的计数。
Type of collection | Value | Description |
Physical | 0x00 | 物理集合用于表示在一个几何点处收集的数据点的一组数据项。 这对于可能需要将测量或感测的数据集与单个点相关联的感测设备是有用的。 它并不表示一组数据值来自一个设备,例如键盘。 在报告多个传感器位置的设备的情况下,物理集合用于显示来自每个单独传感器的数据。 |
Application | 0x01 | 应用程序可能熟悉的一组主要项目。 它还可用于识别在单个设备中用于不同目的的项目组。 常见的例子是键盘或鼠标。 具有集成指点设备的键盘可以被定义为两个不同的应用程序集合。 数据报告通常(但不一定)与应用程序集合相关联(每个应用程序至少有一个报告ID)。 |
Logical | 0x02 | 当一组数据项形成复合数据结构时,使用逻辑集合。 一个例子是数据缓冲区和数据的字节数之间的关联。 该集合建立计数和缓冲区之间的链接。 |
Report | 0x03 | 定义包装报表中所有字段的逻辑集合。 此集合中将包含唯一的报告ID。 应用程序可以轻松确定设备是否支持某种功能。 请注意,可以为Report集合声明任何有效的Report ID值。 |
Named Array | 0x04 | 命名数组是包含选择器用法数组的逻辑集合。 对于给定的功能,类似设备使用的选择器组可以变化。 在记录硬件寄存器时,字段的命名是常见的做法。 要确定设备是否支持Status等特定功能,应用程序可能必须先查询几个已知的Status选择器用法,然后才能确定设备是否支持Status。 命名数组用法允许命名包含选择器的Array字段,因此应用程序只需查询Status用法以确定设备是否支持状态信息。 |
Usage Switch | 0x05 | Usage Switch是一个逻辑集合,用于修改其包含的用法的含义。 此集合类型向应用程序指示在此集合中找到的用法必须是特殊的。 例如,不是在每个可能的功能上声明LED页面上的用法,而是可以将指示符用法应用于Usage Switch集合,并且现在可以将该集合中定义的标准用法识别为功能的指示符而不是功能本身。 请注意,此集合类型不用于标记序号集合,而是使用逻辑集合类型。 |
Usage Modifier | 0x06 | 修改附加到包含集合的用法的含义。 用法通常定义控件的单个操作模式。 使用修饰符允许扩展控件的操作模式。 例如,LED通常打开或关闭。 对于特定状态,设备可能需要通用的闪烁方法或选择标准LED的颜色。 将LED使用附加到Usage Modifier集合将向应用程序指示该使用支持新的操作模式。 |
Reserved | 0x07~0x7F | 保留供将来使用。 |
0x80~0xFF | 厂商自定义的 |
- Collection项目和End Collection项目之间的所有Main项目都包含在集合中。 集合可能包含其他嵌套集合。
- 集合项不会生成数据。 但是,Usage项标记必须与任何集合(例如鼠标或节流)关联。 集合项可以嵌套,除了顶级应用程序集之外,它们始终是可选的。
- 如果遇到未知的供应商定义的集合类型,则应用程序必须忽略该集合中声明的所有主项。 请注意,在该集合中声明的全局项将影响状态表。
- 如果未知用法附加到已知集合类型,则应忽略该集合的内容。 请注意,在该集合中声明的全局项将影响状态表。
- 字符串和物理索引以及分隔符可能与集合相关联。
下面以最前面给出的一个HID报告描述符表,根据前面的学习来一一分析。
因为要用到所有的tag,所以下面先列出所有的tag
-
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 定义输入最大值 =+
127
-
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 关闭集合
按照短项目来分析。
Glibal和Local项相关的细节本节先不描述了,下一节描述,下面例子主要看输入,输入项相关的。
第二行,06 A0 FF 其中0x06对应着Global类项目中的Usage Page项,数据共2字节。数据0xFFA0表明由厂商定义,
第三行,09 A5 其中0x09对应着Local类项的Usage项,数据共一个字节。数据0xA5看后面的Local项章节。
第四行,A1 01 其中0xA1对应着Main类项的Collection项,数据共一个字节。数据0x01表示(Application)本章2.2节。
第五行,09 A6 其中0x09对应着Local类项的Usage项,数据共一个字节。数据0xA6看后面的Local项章节。
第七行,09 A7 其中0x09对应着Local类项的Usage项,数据共一个字节。数据A7看后面的Local项章节。
第八行,15 80 其中0x15对应着Global类项的Logical Minimum项,数据共一个字节。数据看后面的Global章节。
第九行,25 7F 其中0x15对应着Global类项的Logical Maximum项,数据共一个字节。数据看后面的Global章节。
第十行,75 08 其中0x75对应着Global类项的Report Size项,数据共一个字节。指的是报表数据大小5个字节。
第十一行,95 02 其中0x95对应着Global类项的Report Count项,数据共一个字节。指的是是报表个数为2。
第十二行,81 02其中81对对应着Main类项的Input项,数据共一个字节。指的输入数据是变量。
第十四行,09 A9 其中0x09对应着Local类项的Usage项,数据共一个字节。数据A9看后面的Local项章节。
第十五行,15 80 其中0x15对应着Global类项的Logical Minimum项,数据共一个字节。数据看后面的Global章节。
第十六行,25 7F 其中0x15对应着Global类项的Logical Maximum项,数据共一个字节。数据看后面的Global章节。
第十七行,75 08 其中0x75对应着Global类项的Report Size项,数据共一个字节。指的是报表数据大小5个字节。
第十八行,95 02 其中0x95对应着Global类项的Report Count项,数据共一个字节。指的是是报表个数为2。
第十九行,91 02其中81对对应着Main类项的Output项,数据共一个字节。指的输出数据是变量。
第二十行,C0 表示结束集合。
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_16777851/article/details/86321149