上海潤欣科技股份有限公司創研社

引言

USB接口作為PC上最流行和通用的接口，具備可連接多種類型的設備，連接簡單，即插即用，支持熱插撥，多數應用場景下不需要提供獨立的電源，高傳輸速率，高可靠性等特點，被越來越多的產品作為首選接口作為接入PC的連接方式。為了簡化USB設備的開發和接入到PC系統，微軟開發了WinUSB，可以將Winusb.sys作為設備功能驅動程序安裝，并提供WinUSB API供應用程序訪問設備。一直以來，除了USB HID設備，其他類型的設備在WINDOWS環境下需要安裝驅動程序才能工作。要實現USB設備免驅，就只能使用HID設備。而HID設備傳輸速度慢，在有些場合必須使用Bulk類型進行批量傳輸時，就必須使用第三方驅動或者自己開發一個驅動，使得項目開發非常麻煩。現在好了，自從微軟推出了WinUSB，在微軟的最新操作系統上實現簡單的Bulk類型批量傳輸也變得非常的方便快捷，在研發過程當中或者一些對于差異化要求不高的場合，是非常適用且容易實現的。本文致力于實現一個最簡單的WinUSB通信系統，以滿足此類需求。

如何讓嵌入式設備枚舉成WinUSB設備

系統通過USB描述符來確定以何種USB Class類型來工作。如果希望WINDOWS能夠將嵌入式設備識別為WinUSB設備，則其描述符至少應當包含以下字段：

1、支持OS 字符串描述符：

為了讓 USB 驅動程序堆棧了解設備支持擴展的特征描述符，設備必須定義存儲在字符串索引 0xEE 處的 OS 字符串描述符。在枚舉過程中，驅動程序堆棧查詢字符串描述符。如果存在描述符，驅動程序堆棧會假定設備包含一個或多個 OS 特征描述符和檢索這些特征描述符所需要的數據。檢索的字符串描述符具有bMS_VendorCode字段值。該值為1表示USB驅動程序堆棧必須用來檢索擴展特征描述符的供應商代碼。

#define bMS_VendorCode ( 0x01 )

// "MSFT100" : index : 0xEE : langId : 0x0000

const U8 OS_StringDescritpor[ ] =

{ 0x12, 0x03, 'M', 0, 'S', 0, 'F', 0, 'T', 0, '1', 0, '0', 0, '0', 0, bMS_VendorCode, 0 };

2、設置兼容ID特征描述符：

const U8 WINUSB_ExtendedCompatId_Descritpor[ ] =

{

0x28, 0x00, 0x00, 0x00, // dwLength

0x00, 0x01, // bcdVersion

0x04, 0x00, // wIndex

0x01, // bCount

0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // Reserved[7]

0x00, // bFirstInterfaceNumber

0x01, // RESERVED ( 0x01 )

'W', 'I', 'N', 'U', 'S', 'B', 0x00, 0x00, // compactiableID[8]

0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // subCompactiableID[8]

0x00, 0x00, 0x00, 0x00, 0x00, 0x00 // Reserved[6]

};

注：WinUSB還支持復合設備，對于單一傳輸類型最簡系統，我們忽略復合設備的要求即可。compatibleID字段必須指定 "WINUSB" 作為字段值。其他可以根據需求更改。

3、注冊設備接口 GUID描述符：

該描述符用于區分不同的WinUSB設備。

const U8 WINUSB_ExtendedProperty_InterfaceGUID_Descritpor[ ] =

{

0x8E, 0x00, 0x00, 0x00, // dwTotalSize = Header + All sections

0x00, 0x01, // bcdVersion

0x05, 0x00, // wIndex

0x01, 0x00, // wCount

0x84, 0x00, 0x00, 0x00, // dwSize -- this section

0x01, 0x00, 0x00, 0x00, // dwPropertyDataType

0x28, 0x00, // wPropertyNameLength 'D',0,'e',0,'v',0,'i',0,'c',0,'e',0,'I',0,'n',0x00,'t',0,'e',0,'r',0,'f',0,'a',0,'c',0,'e',0, 'G',0,'U',0,'I',0,'D',0,0,0,

0x4E, 0x00, 0x00, 0x00, // dwPropertyDataLength : 78 Bytes = 0x0000004E

'{',0,'1',0,'2',0,'3',0,'4',0, '5',0,'6',0,'7',0,'8',0,'-',0,'1',0,'2',0,'3',0,'4',0,'-',0,'1',0,'3',0,'4',0,'4',0,'-',0,'1',0,'2',0,'3',0,'4',0,'-',0,'1',0,'2',0,'3',0,'4',0,'5',0,'6',0,'7',0,'8',0,'9',0,'A',0,'B',0,'C',0,'}',0,0,0

};// bPropertyData : WCHAR : L"{12345678-1234-1234-1234-123456789ABC}"

4、端點描述符：

按實際的需求的配置端點數量和類型，即可完成嵌入式設備的描述符配置了。

一般固件程序可以通過MCU廠家提供的范例程序進行修改，這里省略USB固件功能的說明。只要包含以上三個描述符中的必須的字段，就可以成功枚舉成USB Device。枚舉成功后在設備WINDOWS設備管理器中可看到類似設備，如下圖1所示。

圖1 成功枚舉為USB Device

如何編寫PC應用程序與嵌入式設備進行USB通信

PC機軟件相對來說比較簡單，并且微軟官方也給出了示例代碼。唯一需要注意的是，對應的軟件程序獲取WinUSB設備句柄的GUID參數，需要與嵌入式設備的描述符中的GUID保持一致。GUID是WinUSB用以區分設備的唯一標志。GUID，是Globally Unique Identifier的簡稱，翻譯為全局唯一標識符，是一種由算法生成的二進制數據，長度為128位的數字標識符。

具體實現步驟如下：

1、創建設備的文件句柄：

調用 SetupDiGetClassDevs 獲取設備信息集的句柄；調用 SetupDiEnumDeviceInterfaces 枚舉設備信息集中的設備接口并獲取有關設備接口的信息；調用 SetupDiGetDeviceInterfaceDetail 獲取設備接口的詳細信息，所獲取的信息通過SP_DEVICE_INTERFACE_DETAIL_DATA結構返回。由于該結構大小無法提前獲取，故需連續兩次調用該函數，第二次調用時接口詳細信息將填充到根據第一次調用返回值所確定大小的該緩沖區，通過緩沖內該結構的DevicePath成員中可獲得“設備路徑”。

2、獲取設備的 WinUSB 接口句柄：

調用 WinUsb_Initialize通過傳遞在創建設備的文件句柄中創建的文件句柄。

3、查詢設備以獲取 USB 描述符：

接下來，查詢設備以獲取特定于 USB 的信息，如設備速度、接口描述符、相關端點及其管道。調用 WinUsb_QueryDeviceInformation 從設備的設備描述符請求信息。調用 WinUsb_QueryInterfaceSettings 并傳遞設備的接口句柄，以獲得對應的接口描述符。調用 WinUsb_QueryPipe 獲取有關每個接口每個終結點的信息。此步驟不是必須的，因為端點方向及傳輸特性由嵌入式設備描述符決定，是已知的。

4、向默認端點發送控制傳輸：

此步驟也不是必須的。一般都不通過默認端點發送有效載荷。

5、發送 I/O 請求：

將數據發送到設備的批量輸入和批量輸出端點，這些端點點可分別用于讀取請求和寫入請求。調用 WinUsb_ReadPipe 從設備的批量輸入端點讀取數據。調用 WinUsb_WritePipe 通過批量輸出端點將數據寫入設備。在嵌入式設備的輸出端點內寫入數據之后，就可以在PC端讀出數據。反之，如果在PC端對嵌入式設備的輸入端點寫入數據，則嵌入式設備會產生一個USB端點寫入事件，具體如何捕捉該事件，則由MCU廠家的產品硬件決定，產生相應的中斷信息，供中斷服務程序來判斷。一般而言，芯片廠家會提供MCU的USB通信基礎范例程序，在其基礎上做簡單的修改和適配即可。

6、釋放設備句柄

在完成對設備的所有必要的調用之后，釋放設備的文件句柄和 WinUSB 接口句柄。CloseHandle 釋放由 CreateFile 創建的句柄。

WinUsb_Free 釋放由 WinUsb_Initialize 返回的設備的 WinUSB 接口句柄。

至此，已經完成了嵌入式設備端固件的USB代碼移植和PC端應用程序的編寫，就可以實現USB免驅設備的通信方式了