基于DWC2的USB驅動開發-IAD描述符詳解

本文轉自公眾號,歡迎關注

基于DWC2的USB驅動開發-IAD描述符詳解 (qq.com)

一.前言

IAD描述符用于一個設備功能關聯多個接口,可以用于實現組合設備。

二.參考文檔

參考《iadclasscode_r10.pdf》

USB Interface Association Descriptor Device Class Code and use Model Revision 1.0 July 23,2003

直接在https://www.usb.org/documents下搜索”USB Interface Association Descriptor Device Class Code”下載

參考《InterfaceAssociationDescriptor_ecn.pdf》

下載地址https://www.usb.org/sites/default/files/iadclasscode_r10.pdf

三.概述

從（USB規范的）第一天起，關于是否應允許多功能設備每個邏輯功能使用一個以上接口，一直存在歧義。核心規范沒有為每個功能含多個接口的情況提供任何特定的框架支持，但幾個設備工作組（DWG）使用它們定義了設備類，并使用不同的方法來確定接口應如何組織在一起。DWG Common Class組在定義標準方法方面做了大量工作，但定義較晚，從未被采用，最終被停用

最近的USB 2.0 ECN接口關聯描述符（IAD）通過在USB設備框架中定義一種標準方法來解決這個問題，該方法用于描述應該綁定到設備驅動程序的同一實例的接口（及其金額選設置）的關聯。參考《InterfaceAssociationDescriptor_ecn.pdf》。

當連接到USB軟件不理解IAD的系統時，使用IAD的新設備存在遺留問題（意味著與設備驅動程序的接口級綁定，而不是設備級綁定）。盡管IAD會被忽略，但由于USB系統軟件無法將接口與驅動程序正確綁定，設備可能無法按預期工作。

USB核心團隊已經分配了一個設備級類代碼，該代碼必須包含在使用IAD的設備實現中。

這提供了在設備枚舉期間對啟用IAD的設備的最簡單檢測，這將允許安裝具有正確解析配置和為使能IAD的設備定位適當的驅動程序能力的專用功能驅動程序。

3.1 IAD的來源背景

ECN即USB Engineering Change Notice,USB的工程變更通知。

《InterfaceAssociationDescriptor_ecn.pdf》此ECN定義了一個新的標準描述符和接口編號規則，允許設備描述哪一個接口和同一個設備功能關聯。這允許操作系統將所有適當的接口綁定到同一驅動程序實例,即多個接口對應一個設備功能。

核心USB框架假設的基本配置模型是，設備上的接口和功能之間始終存在1:1的關聯，即一個接口對應一個設備功能。系統軟件是按照核心規范的意圖設計的，并假設每個功能（和一個接口）有一個驅動程序（見下圖）

一些設備類規范已經超過了核心USB規范框架，并定義了使用多個接口（即多個接口描述符）的設備功能。支持這一點的模型仍然只需要每個功能一個功能驅動程序，但也需要多個接口綁定到同一個驅動程序實例（見下圖）。不幸的是，沒有標準方法允許設備通過設備框架來描述配置中的哪些接口應該與相同的功能相關聯。

此更改通知定義了設備框架的必要擴展，允許設備注釋哪些接口與同一功能相關。這種設備框架擴展最終將被用于所有每個設備功能使用多個接口的設備。

3.2對軟件的影響

對現有操作系統版本和現有設備類沒有影響。系統軟件會忽略新的描述符。他們描述的接口不會改變。使用多個接口來管理單個設備功能的設備的未來實現必須支持此功能。

操作系統當前不支持的設備類會對未來/新的設備實現產生影響。具體來說，如果一個設備實現包括多個功能單元（每個單元有多個接口），那么該設備將僅在支持此新描述符的操作系統實現上正確枚舉

為了更容易地增強現有的操作系統實現，使其能夠處理使用該描述符的設備，將分配設備類代碼，目的是所有使用接口關聯描述符的設備都將在其設備描述符中使用該類代碼。這將允許輕松安裝一個新的驅動程序，該驅動程序知道如何解析和枚舉包括接口關聯描述符的配置。IAD的分類代碼將記錄在usb.org網站上。

現有設備類工作組負責確定是否需要修改其單獨的規范以使用或利用此新的框架擴展。

3.3合規性測試影響

最終必須更新標準合規工具集（USBCV），以檢查這些新描述符的格式（和使用）。

此外，必須為合規工具建立一些規則，以確定哪個設備應該使用這些描述符，并因未使用這些描述符而使其失敗。

四.IAD描述符

4.1描述符類型

添加了新的IAD描述符類型11。

以下建議與以前的操作系統向后兼容。它保留了當前的接口定義，并添加了一個新的描述符類型。對于舊的操作系統版本，新的描述符將被忽略，舊的機制將占上風。對于新的操作系統版本，新的描述符將生效。

將以下內容添加到USB規格書2.0表9-6中（注意，核心規范目前定義的值為1-8。自發布以來，值9和10的分配如下所述）。

Descriptor Types	Value
DEVICE	1
CONFIGURATION	2
STRING	3
INTERFACE	4
ENDPOINT	5
DEVICE_QUALIFIER	6
OTHER_SPEED_CONFIGURATION	7
INTERFACE_POWER	8
OTG	9
DEBUG	10
INTERFACE_ASSOCIATION	11

USB規格書2.0中P251中內容如下,即添加了類型11的IAD描述符類型。

Table 9-5. Descriptor Types

Descriptor Types	Value
DEVICE	1
CONFIGURATION	2
STRING	3
INTERFACE	4
ENDPOINT	5
DEVICE_QUALIFIER	6
OTHER_SPEED_CONFIGURATION	7
INTERFACE_POWER1	8

4.2IAD描述符內容

以下是接口關聯描述符的定義。在下一次規范修訂更新時，應將其作為新的第9.6.6節（將當前第9.6.6章移至第9.6.7章，依此類推）。

接口關聯描述符用于描述兩個或多個接口與同一功能相關聯?！瓣P聯”包括兩個或多個接口及其所有可選設置接口。

對于需要多個接口的每個設備功能，設備必須使用接口關聯描述符。

接口關聯描述符總是作為GetDescriptor(configuration)請求返回的配置信息的一部分返回。無法使用GetDescriptor()或SetDescriptor()請求直接訪問接口關聯描述符。

接口關聯描述符必須位于與其關聯的接口的接口描述符集(包括所有可選設置)之前。

關聯接口集中的所有接口編號必須是連續的。

表9-Z顯示了標準接口關聯描述符。

接口關聯描述符包括函數類、子類和協議字段。這些字段中的值可以與任何一個相關接口的接口類、子類和協議值相同。

對于現有的設備類，優選的實現是使用關聯接口列表中第一個接口的接口類、子類和協議字段值。

注意：由于此特定功能未包含在早期版本的USB規范中，因此現有的USB操作系統實現將如何支持使用此描述符的設備存在問題。強烈建議使用接口關聯描述符的設備實現使用設備描述符中的多接口功能類代碼。這允許簡單而容易地識別這些設備，并允許在某些操作系統上安裝升級驅動程序，該驅動程序可以解析和枚舉包括接口關聯描述符的配置。多接口函數類代碼記錄在http://www.usb.org/developers/docs網站

Table 9–Z. Standard Interface Association Descriptor

偏移	區域	大小	值	描述
0	bLength	1	Number	描述符字節數.
1	bDescriptorType	1	Constant	INTERFACE ASSOCIATION 描述符即11.
2	bFirstInterface	1	Number	和該功能關聯的第一個接口序號
3	bInterfaceCount	1	Number	和該功能關聯的接口個數
4	bFunctionClass	1	Class	USB-IF分配的類編碼. 不能寫0 0xFF表示廠商自定義 其他值由USB-IF分配.
5	bFunctionSubClass	1	SubClass	USB-IF分配的子類編碼. bFunctionClass 不為FFH 則所有值都由USB IF分配.
6	bFunctionProtocol	1	Protocol	USB-IF分配的協議編碼. 這些代碼由bFunctionClass和bFunctionSubClass字段的值限定。
7	iFunction	1	Index	描述該功能的字符串描述符索引

其中bFunctionClass ，bFunctionSubClass，bFunctionProtocol 的值需要根據具體的設備類文檔確定

比如UVC參考《UVC 1.5 Class specification.pdf》Universal Serial Bus Device Class Definition for Video Devices Revision 1.5 August 9, 2012 P60

Table 3-1 Standard Video Interface Collection IAD

Offset	Field	Size	Value	Description
0	bLength	1	Number	Size of this descriptor, in bytes: 8
1	bDescriptorType	1	Constant	INTERFACE ASSOCIATION Descriptor.
2	bFirstInterface	1	Number	Interface number of the first VideoControl interface that is associated with this function.
3	bInterfaceCount	1	Number	Number of contiguous VideoStreaming interfaces that are associated with this function. The count includes the first VideoControl interface and all its associated VideoStreaming interfaces.
4	bFunctionClass	1	Class	CC_VIDEO. Video Interface Class code (assigned by the USB). See section A.1, "Video Interface Class Code".
5	bFunctionSubClass	1	SubClass	SC_VIDEO_INTERFACE_COLLECT ION. Video Interface Subclass code. Assigned by this specification. See section A.2, "Video Interface Subclass Codes".
6	bFunctionProtocol	1	Protocol	Not used. Must be set to PC_PROTOCOL_UNDEFINED.
7	iFunction	1	Index	Index of a string descriptor that describes this interface. This must be used for the device (function) name and be implemented in US English (LANGID = 0x0409) at the minimum.

4.3UAC的IAD實例

1. -------------------IADDescriptor--------------------

2.bLength:0x08(8bytes)

3.bDescriptorType:0x0B(InterfaceAssociationDescriptor)

4.bFirstInterface:0x02(Interface2)

5.bInterfaceCount:0x02(2Interfaces)

6.bFunctionClass:0x01(Audio)

7.bFunctionSubClass:0x02(AudioStreaming)

8.bFunctionProtocol:0x00

9.iFunction:0x08(StringDescriptor8)

10.Language0x0409:"usb-audio"

11.Data(HexDump) :080B020201020008 ........

4.4UVC的IAD實例

1. -------------------IADDescriptor--------------------

2.bLength:0x08(8bytes)

3.bDescriptorType:0x0B(InterfaceAssociationDescriptor)

4.bFirstInterface:0x00(Interface0)

5.bInterfaceCount:0x02(2Interfaces)

6.bFunctionClass:0x0E(Video)

7.bFunctionSubClass:0x03(VideoInterfaceCollection)

8.bFunctionProtocol:0x00(PC_PROTOCOL_UNDEFINED)

9.iFunction:0x05(StringDescriptor5)

10.Language0x0409:"usb-webcam"

11.Data(HexDump) :080B00020E030005 ........

4.5CDC的IAD實例

1. -------------------IADDescriptor--------------------

2.bLength:0x08(8bytes)

3.bDescriptorType:0x0B(InterfaceAssociationDescriptor)

4.bFirstInterface:0x04(Interface4)

5.bInterfaceCount:0x02(2Interfaces)

6.bFunctionClass:0x02(CommunicationsandCDCControl)

7.bFunctionSubClass:0x02

8.bFunctionProtocol:0x01

9.iFunction:0x0A(StringDescriptor10)

10.Language0x0409:"usb-com"

11.Data(HexDump) :080B04020202010A ........

五.使用IAD時的設備描述符

5.1使用IAD時的設備描述符

使用IAD的設備必須使用下表中所示的示例設備描述符中定義的設備類bDeviceClass、子類bDeviceSubClass和協議代碼bDeviceProtocol其他的參考USB2.0的規格書usb_20.pdf的Table 9-8. Standard Device Descriptor。這組類代碼被定義為多接口功能設備類代碼。

偏移	區域	大小	值	描述
0	bLength	1	Number	描述字節數
1	bDescriptorType	1	Constant	見usb_20.pdf的Table 9-8. Standard Device Descriptor
2	bcdUSB	2	BCD
4	bDeviceClass	1	EFH	Miscellaneous Device Class
5	bDeviceSubClass	1	02H	Common Class
6	bDeviceProtocol	1	01H	Interface Association Descriptor
7	bMaxPacketSize0	1	Number	見usb_20.pdf的Table 9-8. Standard Device Descriptor
8	idVendor	2	ID
10	idProduct	2	ID
12	bcdDevice	2	BCD
14	iManufacturer	1	Index
15	iProduct	1	Index
16	iSerialNumber	1	Index
17	bNumConfigurations	1	Index

使用IAD類代碼的示例設備描述符

5.2使用IAD的設備描述符實例

1. ----------------------DeviceDescriptor----------------------

2.bLength:0x12(18bytes)

3.bDescriptorType:0x01(DeviceDescriptor)

4.bcdUSB:0x200(USBVersion2.0)

5.bDeviceClass:0xEF(Miscellaneous)

6.bDeviceSubClass:0x02

7.bDeviceProtocol:0x01(IAD-InterfaceAssociationDescriptor)

8.bMaxPacketSize0:0x40(64bytes)

9.idVendor:0x2BC5(Orbbec3DTech.Int'lInc.)

10.idProduct:0x0529

11.bcdDevice:0x0200

12.iManufacturer:0x01(StringDescriptor1)

13.Language0x0409:"webcamvendor"

14.iProduct:0x02(StringDescriptor2)

15.Language0x0409:"webcamproduct"

16.iSerialNumber:0x03(StringDescriptor3)

17.Language0x0409:"00000000"

18.bNumConfigurations:0x01(1Configuration)

19.Data(HexDump) :12010002EF020140C52B290500020102 .......@.+).....

20. 0301 ..

六.IAD使用模型

下圖提供了一個示例，說明在典型的設備實現中如何使用IAD。

核心USB規范并沒有指定從GetDescriptor(Configuration)請求返回的描述符集，應該如何構造的組織(位置關系)要求。

下圖說明了如何組織這些描述符的推薦布局，以便主機軟件可以輕松地解析它們，并明確地知道，要向每個功能驅動程序提供哪些描述符。

組織描述符集的一般方法是“按設備功能”對它們進行分組。這基本上意味著特定設備功能的所有描述符應始終位于“一起”（如圖所示）。

此外,圖中說明了描述符集應如何綁定到設備驅動程序。需要注意,對于類特定描述符應如何與IAD關聯進行分組,可能存在特定(附加)要求。這些將在特定的設備類文檔中指定,比如UVC參考《UVC 1.5 Class specification.pdf》Universal Serial Bus Device Class Definition for Video Devices Revision 1.5 August 9, 2012 P60。

(1)在示例框圖的頂部，多接口功能設備類(Multi-Interface Function Device Class)設備,其設備描述符包括設備類bDeviceClass、子類bDeviceSubClashh和協議代碼bDeviceProtocol，他們的值必須分別是0xEF(Misc),0x02(Common Class),0x01(IAD).

(2)接下來是配置描述符集。在高層次上，該特定配置包括三個設備功能。配置描述符和第一個接口或IAD描述符之間的任何描述符都應被視為“全局”，并傳遞給每個功能設備驅動程序（見示例）。

(3)第一個功能關聯包括兩個接口（包括所有類特定描述符和可選設置alternate settings）。第二設備功能是單個接口功能，并且不需要IAD。第三個設備功能與第一個類似。對于每個設備功能，系統軟件必須向設備驅動程序提供“關聯”中的所有描述符以及上述“全局”描述符。

(4)bInterface Count字段中的值必須包括預期集合中的所有接口。例如，假設一個多接口功能的接口編號為N到M。bFirstInterface字段值為N，bInterface Count的值則為(M-N)+1(因為關聯中的所有接口都必須是數字連續的,所以算法(M-N)+1總是有效的)。注意，每個接口可以有零個或多個可選設置alternate settings，但可選設置不包括在bInterface Count的計算中。

(5)對于使用IAD的設備功能（如示例中的第一個和第三個功能），USB系統軟件應構建“硬件標識符”，用于使用設備描述符中的idVendor和idProduct以及IAD中的bFirstInterface字段定位和加載設備驅動程序。此外，系統軟件應使用IAD中的類代碼字段（bFunctionClass、bFunctionSubClass、bFunctionProtocol）構建“兼容性標識符”。

使用接口關聯描述符的示例設備框圖

七.總結

1.在一個設備功能需要關聯多個接口時需要使用IAD描述符,比如UVC,UAC, 而一個配置描述符下可以使用多個IAD即實現了組合設備,比如UVC+UAC_CDC, 使用IAD時此時設備描述符的設備類bDeviceClass、子類bDeviceSubClashh和協議代碼bDeviceProtocol，他們的值必須分別是0xEF(Misc),0x02(Common Class),0x01(IAD)。詳見前面的實例。

2.IAD描述的內容參考前面的實例,bFunctionClass ，bFunctionSubClass，bFunctionProtocol 的值需要根據具體的設備類文檔確定,可以參考前面的實例。

---

審核編輯黃宇