技术的乐趣在于分享,欢迎多多交流,多多沟通。
全部博文(877)
分类: C/C++
2014-07-03 15:51:03
USB的描述符与命令请求详解
一、 描述符
1. 什么是描述符
所谓描述符,就是用于描述设备特性的具有特定格式排列的一种数据组织结构。
2. 描述符的作用
描述符的作用在于设备向主机汇报自己的信息、特征,主机根据这些信息从而加载相应
的驱动程序。
3. 描述符的分类
描述符分为三大类:标准描述符、设备类描述符、厂商描述符。
除字符串描述符可选外,任何设备都必须包含剩下的几种标准描述符。
在USB1.0中规定了5种标准的描述符:
设备描述符
配置描述符
接口描述符
端点描述符
字符串描述符
规定的设备类描述符有:集线器类描述符、人机接口类描述符。
下表是三种描述符的类型值:
表1 . USB描述符的类型值 |
||
类型 |
描述符 |
描述符值 |
标准描述符 |
设备描述符(Device Descriptor) |
0x01 |
配置描述符(Configuration Descriptor) |
0x02 |
|
字符串描述符(String Descriptor) |
0x03 |
|
接口描述符(Interface Descriptor) |
0x04 |
|
端点描述符(EndPont Descriptor) |
0x05 |
|
类描述符 |
集线器类描述符(Hub Descriptor) |
0x29 |
人机接口类描述符(HID) |
0x21 |
|
厂商定义的描述符 |
|
0xFF |
4. 使用的几种类
4.1 设备类DeviceClass
下表是设备类值的含义。
表2. 设备的类别(bDeviceClass) |
||
值(十进制) |
值(十六进制) |
说明 |
0 |
0x00 |
使用接口描述符中提供的类 |
2 |
0x02 |
通信类(CDC) |
9 |
0x09 |
集线器类 |
220 |
0xDC |
用于诊断用途的设备类 |
224 |
0xFE |
混杂类型设备类 |
255 |
0xFF |
厂商定义的设备类 |
4.2 接口类InterfaceClass
下表是接口类值的含义。
表3. USB协议定义的接口类别(bInterfaceClass) |
|
值(十六进制) |
类别 |
0x01 |
音频类 |
0x02 |
通信类(CDC) |
0x03 |
人机接口类(HID) |
0x05 |
物理类 |
0x06 |
图像类 |
0x07 |
打印机类 |
0x08 |
大数据存储类 |
0x09 |
集线器类 |
0x0A |
CDC数据类 |
0x0B |
智能卡类 |
0x0D |
安全类 |
0xDC |
诊断设备类 |
0xE0 |
无线控制器类 |
0xEF |
混杂设备类 |
0xFE |
特定应用类(包括红外的桥接器等) |
0xFF |
厂商定义的设备 |
4.3 类的交叉与独享
在描述符中,只有设备描述符和接口描述符中会有类别之分,即只有设备和接口会分
类使用,不过有些类别的使用只需经过设备或接口的区分就可彻底清楚明白,这说明在设备类别和接口类别的定义上会有共同的类别名称。而有些类别则是设备或接口独享的,下表是与使用设备相关的类别划分交叉或共享情况:
Base Class |
Usage |
Description |
00h |
Device |
|
01h |
Interface |
|
02h |
Both |
|
03h |
Interface |
|
05h |
Interface |
|
06h |
Interface |
|
07h |
Interface |
|
08h |
Interface |
|
09h |
Device |
|
0Ah |
Interface |
|
0Bh |
Interface |
|
0Dh |
Interface |
|
0Eh |
Interface |
|
0Fh |
Interface |
|
10h |
Interface |
|
DCh |
Both |
|
E0h |
Interface |
|
EFh |
Both |
|
FEh |
Interface |
|
FFh |
Both |
(此表也适用于标准命令Get_Descriptor中wValue域高字节的取值含义)
【说明:】在设备或接口分类上均可彻底分清使用的(Usage = Both),即在任一处描述符中定义即可的分清楚使用的类(Usage = Both)的基本类有:
02h ------------- 通信及CDC控制类;
DCh ------------ 诊断设备类;
EFh ------------- 混杂设备类;
FFh ------------- 厂商定义的设备类。
5. 标准描述符
5.1 设备描述符
表4、USB设备描述符的结构 |
||||
偏移 |
域 |
Bytes |
值 |
描述 |
0 |
bLength |
1 |
数字 |
此描述符的字节数 |
1 |
bDecriptorType |
1 |
常量 |
描述符的类型(此处应为0x01,即设备描述符) |
2 |
bcdUSB |
2 |
BCD码 |
USB版本号(BCD 码) |
4 |
bDeviceClass |
1 |
设备类 |
设备类码: bDeviceClass = FFh,表明设备类是由厂商自定义的。bDeviceClass = 1~FEh,查表可得对应设备类值,该设备在不同的接口上支持不同的类。且这些接口可能不能独立工作。此值指出了这些接口集体的类定义。 |
5 |
bDeviceSubClass |
1 |
设备子类 |
设备子类码: |
6 |
bDevicePortocol |
1 |
设备协议 |
协议码 |
7 |
bMaxPacketSize0 |
1 |
数字 |
端点0的最大包大小(仅8,16,32,64 |
8 |
idVendor |
2 |
ID |
厂商标志(由USB-IF组织赋值) |
10 |
idProduct |
2 |
ID |
产品标志(由厂商赋值) |
12 |
bcdDevice |
2 |
BCD 码 |
设备版本号(BCD 码) |
14 |
iManufacturer |
1 |
索引 |
描述厂商信息的字符串描述符的索引值。 |
15 |
iProduct |
1 |
索引 |
描述产品信息的字串描述符的索引值。 |
16 |
iSerialNumber |
1 |
索引 |
描述设备序列号信息的字串描述符的索引值。 |
17 |
bNumConfigurations |
1 |
数字 |
可能的配置描述符数目 |
【说明1:】当设备类型bDeviceClass = 0时,说明类型将由接口描述符中定义的为准。
【说明2:】从设备描述符表格中可知,有3个索引值:厂商信息索引、产品信息索引、设备序列号索引,这意味着,将有3个字符串描述符为其准备。
5.2 配置描述符
配置描述符中包含了配置描述符本身的长度、所有配置信息的总长度、供电方式及远
程唤醒、供电量。
如果主机发出标准命令Get_Descriptor要求获得设备的某个配置描述符时,该配置应用的所有信息都将发给主机,它包括:该标准配置符本身、该配置所包含的所有接口、端点描述符及设备类描述符和厂商描述符。
下表为配置描述符结构:
表8、USB配置描述符的结构 |
||||
偏移量 |
域 |
大小 |
值 |
描述 |
0 |
bLength |
1 |
数字 |
此描述表的字节数长度。 |
1 |
bDescriptorType |
1 |
常量 |
配置描述表类型(此处为0x02) |
2 |
wTotalLength |
2 |
数字 |
此配置信息的总长(包括配置,接口,端点和设备类及厂商定义的描述符),即:将要返回的配置信息总长度。 |
4 |
bNumInterfaces |
1 |
数字 |
此配置所支持的接口个数 |
5 |
bCongfigurationValue |
1 |
数字 |
在SetConfiguration()请求中用作参数来选定此配置。 |
6 |
iConfiguration |
1 |
索引 |
描述此配置的字串描述符的索引 |
7 |
bmAttributes |
1 |
位图 |
配置特性: |
8 |
MaxPower |
1 |
mA |
在此配置下的总线电源耗费量。以 2mA 为一个单位。 |
【说明1:】配置描述符也包含了个用于描述符该配置的字符串描述符索引iConfiguration,这说明将有个字符串描述符为其准备。
【说明2:】枚举的过程可分为4个状态阶段:接入状态阶段、缺省状态阶段、地址状态阶段、设置状态阶段,各状态阶段任务如下:
接入状态阶段-----------主机检测到新设备接入后,将复位总线(释放总线于空闲状态)。
缺省状态阶段-----------主机利用0x00地址访问新接入的设备,读取部分描述符后,会分配个设备地址。
地址状态阶段-----------主机再次复位总线,然后用新分配的地址获取设备所有的描述符。
设置状态阶段-----------主机根据设备的描述符,会对设备作些相关的配置。
【说明3:】bCongfigurationValue-----------USB设备的配置值。用于存放主机执行SetConfiguration命令的设置值。当主机发送GetConfiguration命令时,设备将向主机返回1个字节的配置值。然而,USB设备处于不同的状态时,对GetConfigration的请求也有不同的响应:
1.> 在枚举阶段,若设备处于地址状态时,对GetConfigration的请求返回为0;
2.> 在枚举阶段,若设备处于默认状态(缺省状态)时,对GetConfigration的请求视为无效;
3.> 在枚举阶段,若设备处于配置状态时,对GetConfigration的请求将返回bConfigurationValue字段的值(该值可能是配置描述符的默认值,也可能是USB主机的设置值,这要看在执行GetConfigration命令前是否执行了SetConfigration命令)。
因为主机要执行SetConfigration命令,所以bCongfigurationValue的默认值没什么用。实际上主机给bCongfigurationValue赋值后,bCongfigurationValue值就充当配置描述符的编号,用以区分不同的配置,因为一个设备可能有多个配置。
5.3 接口描述符
USB设备的接口,并不指物理接口,更确切的说应该是“功能接口“,是个赋予特定功能逻辑概念,
是由一组物理端点为实现这一特定功能而凝聚的集合。
//定义标准的接口描述符结构
typedef struct _INTERFACE_DESCRIPTOR_STRUCT
{
BYTE bLength; //接口描述符的字节数大小
BYTE bDescriptorType; //接口描述符的类型编号
BYTE bInterfaceNumber; //接口的编号
BYTE bAlternateSetting; //可替换的接口描述符编号。实际就是接口的描述符的编号。
BYTE bNumEndpoints; //该接口使用的端点数,不包括端点0
BYTE bInterfaceClass; //接口类
BYTE bInterfaceSubClass; //接口子类
BYTE bInterfaceProtocol; //接口遵循的协议
BYTE iInterface; //描述该接口的字符串索引值
}INTERFACE_DESCRIPTOR_STRUCT, * pINTERFACE_DESCRIPTOR_STRUCT;
【说明1:】接口描述符中用到接口编号bInterfaceNumber,以区分在同一配置下的不同的接口。同时还有该接口描述符的索引iInterface,这意味着将为其准备准备一个字符串描述符。
【说明2:】接口描述符中有一项:可替换的接口描述符编号bAlternateSetting,表示对某一接口进行描述的描述符编号。虽然,USB设备的配置与配置描述符是一一对应的,即一个配置只能由一个配置描述来描述它,但一个接口却允许有多种描述符来描述它,尽管接口描述符的编号还是唯一一个。说白了就是:一个接口有唯一的一个接口编号,但一个接口却可以有多个不同的描述符编号,而这些不同的接口描述符的编号值就是bAlternateSetting。所以,通过bInterfaceNumber可以选定一个唯一的接口,然后再通过bAlternateSetting选择想要的对该接口的描述。主机通过GetInterface可以获取当前正在使用的接口及接口描述,通过SetInerface可以选定某接口及其使用的描述符。
5.4 端点描述符
端点是设备与主机之间进行数据传输的逻辑接口,除配置使用的端点0(控制端点,一般一个设备只有一个控制端点)为双向端口外,其它均为单向。端点描述符描述了数据的传输类型、传输方向、数据包大小和端点号(也可称为端点地址)等。
每个设备必须要有一个默认的控制型端点,地址为0,它的数据传输为双向,而且没有专门的描述符,只是在设备描述符中定义了它的最大包长度。主机通过此端点向设备发送命令,获得设备的各种描述符的信息,并通过它来配置设备。
//定义标准的端点描述符结构
typedef struct _ENDPOINT_DESCRIPTOR_STRUCT
{
BYTE bLegth; //端点描述符字节数大小
BYTE bDescriptorType; //端点描述符类型编号
BYTE bEndpointAddress; //端点地址及输入输出属性
BYTE bmAttributes; //端点的传输类型属性
WORD wMaxPacketSize; //端点收、发的最大包大小
BYTE bInterval; //对周期性端点的访问间隔
}ENDPOINT_DESCRIPTOR_STRUCT, * pENDPOINT_DESCRIPTOR_STRUCT;
【说明1:】端点的传输类型字节bmAttributes,描述了该端点的传输特性:0~1bit定义了传输类型---------00=控制传输、01=同步传输、10=批量传输、11=中断传输。
【说明2:】周期端点的访问周期字节bInterval,定义了该端点被主机的访问周期,此域值对于批量传输和控制传输毫无意义。对于同步传输,其值必须为1,即1ms为标准的同步帧周期。对于中断传输,该值为1~255,即1ms~255ms。
5.5 字符串描述符
字符串描述符是一种可选的USB标准描述符,描述了如制商、设备名称或序列号等信息。如果一个设备无字符串描述符,则其它描述符中与字符串有关的索引值都必须为0。字符串使用的是Unicode编码。
字符串描述符是用字符的形式描述设备、配置、接口、端点等信息。
字符串描述符以一种格式2类符值的方式存在:
1.> 显示语言的字符串描述符-----------该字符串描述符表明了设备支持哪几种语言。
2.> 显示信息的字符串描述符-----------用于描述具体的信息。
标准的字符串描述符的格式为:
表9. 字符串描述符 |
||||
偏移量 |
域 |
大小 |
值 |
描述 |
0 |
bLength |
1 |
数字 |
此描述表的字节数(bString域的数值N+2) |
1 |
bDescriptorType |
1 |
常量 |
描述符类型(此处应为0x03) |
2~N |
Strings |
N |
数字 |
字符串 |
显示语言的字符串描述符与显示信息的字符串描述符的区别在于Strings项的不同,对于显示语言的字符串描述符来说Strings项由多个wLANGID[n]数组元素组成,每个wLANGID[n]是一个双字节的代表语言的ID值。而对于显示信息的字符串描述符而言,Strings则是描述信息后的一组UNICODE编码。
为什么会出现这两种情况,原因在于访问字符串描述符的过程,主机请求访问某个字符串描述符的步骤分成两步:
第一步:获取语言信息---------------首先主机向设备发送标准请求命令Get_Descriptor,其参数为:描述符类型=字符串描述符,字符串的索引值=0,语言=0,这样设备将返回显示语言的字符串描述符,从而主机知道了设备能支持哪些语言。
第二步:主机根据自已需要的语言,再次向设备发出标准请求命令Get_Descriptor,其参数为:描述符类型=字符串描述符,字符串索引值=目标字符串索引值,语言=目标语言。这次设备将返回目标已经明确的显示信息的字符串描述符。
【说明1:】只有字符串描述符的长度不是固定的,其长度为N+2,其中N代表Strings项的字节数,2代表字符串描述符的bLength、bDescritorType所占的两个字节。
5.6 设备类描述符之HID描述符
在USB协议中,HID设备的描述符没有划作为标准的描述符,而是作为一类设备单独划分出来进行
描述,以设备类的方式来描述它。所以,描述它的格式用设备类描述符。
HID设备的信息在设备描述符和配置描述符中都不包含,而是包含在接口描述符中,所以在使用HID设备时,其设备描述符中的相关项应定义如下:
bDeviceClass=0;
bDeviceSubClass=0;
bDeviceProtocol=0;
其接口描述符应该:
bInterfaceClass=0x03
另外,对无引导的HID设备,其接口描述符中子类代码bInterfaceSubClass应置0,此时bInterfaceProtocol无效,置零即可。即为:
bInterfaceClass=0x03
bInterfaceSubClass=0
bInterfaceProtocol=0
对支持引导的USB设备,其接口描述符中子类代码bInterfaceSubClass应置1,此时bInterfaceProtocol可以为1或2,1表示键盘接口,3表示鼠标接口。其参考设置如下:
bInterfaceClass=0x03
bInterfaceSubClass=1
bInterfaceProtocol=1或2
下面是HID设备类描述符:
【说明1:】HID设备类描述符并不是说仅用这一个描述符就可描述清楚这类设备,而是指HID设备除包含所有的标准描述符外,还需这个HID设备来补充描述。也就是说,在使用一般的设备时,只需使用标准的描述符就可描述清楚,而若使用HID设备时,除了要使用全部的标准的描述符外还需HID描述符来补充描述。同时,从HID描述符中看出,它还将引出HID的报告描述符,在此不讲述。可以这么说,设备类描述符是作为一个对标准描述进行补充描述的描述符。
6. 描述符的编号及索引
1.> 一个USB设备只能拥有一个设备描述符,故设备描述符不需要编号。但设备描述符通常会提供设
备最基本的文字描述信息,通常包含厂商、设备、产品的信息,故它拥有3个字符串描述符的索引,这3个索引将指向3个字符串描述,分别描述厂商信息、产品信息、设备序列号信息。简言之,设备描述符指示了设备有几种配置,及厂商、产品、设备序列号的字符串描述符索引。
2.> 配置描述符提供了相应的配置参数和查找参数:配置描述符编号bCongfigurationValue、配置
描述符的字符串描述符的索引。
3.> 接口描述提供了该接口的应用参数和查找参数:接口编号bInterfaceNumber、接口描述符编号
bAlternateSetting、该接口描述符对应的字符串描述符的索引。
4.> 字符串描述符是对各描述符所需的字符信息描述的实现,每个描述符所需的字符信息描述的索
引都将对应一个字符串描述符。但通常都不那么做,而是把所有的字符描述的实现都写在一个总的字符串描述符中,即字符串描述符的bStrings项,它们之间用索引来区分。
7. 描述符的获取
7.1 获取描述符的命令格式
命令码CmdCode = GetDescriptor , 格式如下:
bmRequestType |
bRequest |
wValue |
wIndex |
wLength |
0x80 |
0x60 |
类型和索引 |
0或语言ID |
描述符长度 |
wValue-----------其高字节wValue_H指明要获取的描述符类型(实际只有3种类型:设备描述符类型、配置
描述符类型、字符串描述符类型),低字节wValue_L指明目标描述符的索引,然而wValue_L
的值只对配置描述符和字符串描述符有效,而对设备描述符无效。
wIndex-----------只对字符串描述符有意义,对其它描述符时该值为0.。当然对于字符串描述符时,其值也
可为0,表示要获取“显示语言的字符串描述符” ,若为其它值则代表了确定的语言ID,
即表明要获取指定了语言的“显示信息的字符串描述符” 。
wLength--------主机要求的返回的描述符长度。如果wLength大于实际的描述符长度,则以实际描述符长度
为准;如果wLength小于实际描述符长度,则以wLength值为准。
7.2 获取描述符的过程
获取描述符属于枚举的过程,其整个过程当然必经Setup传输的3大过程:Setup过程、数据过程、状
态信息过程。
首先,在Setup过程中,主机发送GetDescriptor命令。若成功,设备就开始准备数据,通信将继续向
前推进,进入数据过程。
然后,在数据过程中,主机启动IN事件,设备就把准备好的数据(描述符)发送出去。若成功,则
通信继续向前推进,进入状态信息过程。
最后,在状态信息过程,主机发送通信过程的信息状态,祝贺并告知通信完美结束。
7.3 获取配置描述符
对于主机来说,配置是广义的,包括狭义的配置、接口配置、端点配置等,而接口配置、端点配置等
都隶属于标准配置描述符,故主机若要求获取配置描述符时,实际上是要求获取除设备描述符和字符串描述符以外的所有描述符。
对于只有标准描述符的设备而言,当主机要求或者配置描述符时,需设备按照顺序把标准配置描述符、标准接口描述符、标准端点描述符一次性发给主机。
所以,通常在写程序时,会将广义上的“配置”打成一个包,在包中,由标准配置描述符引领,按照发送顺序依次实现标准接口描述符、标准端点描述符等。这样做的理由是,在标准配置描述符中有一项wTotalLength,它代表广义上的配置包描述符总长度,根据这个参数就可把广义的配置包描述符一起发给主机,以避免多个描述符时的多次传输。
bmRequestType |
bRequest |
wValue |
wIndex |
wLength |
0x80 |
0x60 |
类型和索引 |
0或语言ID |
描述符长度 |
wValue _H = 配置描述符类型。
wValue _L = 配置描述符编号(索引),实际为bCongfigurationValue值。
wIndex = 0 。
wLength,其值由主机自己规定。
因为,是按确定的顺序发送的,故主机解析的结果也将一一对应。
下面是一个广义配置包描述符的结构模板:
uint8_t USB_ConfigDescriptor[] = {
标准配置描述符的实现;
标准接口描述符的实现;
标准设备类描述符的实现;
标准端点描述符的实现;
};
7.4 获取字符串描述符
从设备描述符到端点描述符,需要许多的信息描述,即需要许多字符串描述符来描述它们的信息。然
而,标准字符串中没有总长度显示项wTotalLength,且每个字符串描述符的格式都一样,所以不可能向获取配置描述符那样,用广义的配置包描述符一起发给主机,况且有些字符串描述符不是必须的,所以很难做到统一的格式。
不过,为了方便管理,在编程时通常还是把所有的字符串描述符组织在一起,不过主机在访问它们时只能一个一个的访问,而不能打包访问,它们之间的选取是依赖各个字符串描述符的长度进行跳过操作来实现的。所以这种组织在一起,只是为了方便管理或好看,而没有其它任何作用,组织的形式通常以“显示语言的字符串描述符”领头,模板如下:
uint8_t USB_StringDescriptor[] = {
显示语言的标准字符串描述符;
显示信息的标准字符串描述符1 ;
… …
显示信息的标准字符串描述符n ;
};
在字符串描述符组织中,各个字符串是怎么区分的?是应用程序,因为这个组织是编写应用程序时自己规定内部秩序的,故组织中各个字符串描述符对应的索引,程序员当然知道。
bmRequestType |
bRequest |
wValue |
wIndex |
wLength |
0x80 |
0x60 |
类型和索引 |
0或语言ID |
描述符长度 |
wValue _H = 字符串描述符类型。
wValue _L = 字符串描述符对应的编号(索引)。
wIndex = 0 或ID。
wLength,其值由主机自己规定。
在获取字符串描述符的第一步:获取设备所支持的语言中,wValue _L = 0,wIndex = 0 ,设备将把显示语言的标准字符串描述符发给主机,主机会从中挑选一种语言。
在获取字符串描述符的第二步:获取显示信息的字符串描述符中,wValue _L = 目标字符串对应的编号,wIndex=语言ID,设备则把确定的字符串描述符发给主机。
二、 标准命令