上海潤(rùn)欣科技股份有限公司創(chuàng)研社

引言

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

如何讓嵌入式設(shè)備枚舉成WinUSB設(shè)備

系統(tǒng)通過(guò)USB描述符來(lái)確定以何種USB Class類型來(lái)工作。如果希望WINDOWS能夠?qū)⑶度胧皆O(shè)備識(shí)別為WinUSB設(shè)備，則其描述符至少應(yīng)當(dāng)包含以下字段：

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

為了讓 USB 驅(qū)動(dòng)程序堆棧了解設(shè)備支持?jǐn)U展的特征描述符，設(shè)備必須定義存儲(chǔ)在字符串索引 0xEE 處的 OS 字符串描述符。在枚舉過(guò)程中，驅(qū)動(dòng)程序堆棧查詢字符串描述符。如果存在描述符，驅(qū)動(dòng)程序堆棧會(huì)假定設(shè)備包含一個(gè)或多個(gè) OS 特征描述符和檢索這些特征描述符所需要的數(shù)據(jù)。檢索的字符串描述符具有bMS_VendorCode字段值。該值為1表示USB驅(qū)動(dòng)程序堆棧必須用來(lái)檢索擴(kuò)展特征描述符的供應(yīng)商代碼。

#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、設(shè)置兼容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還支持復(fù)合設(shè)備，對(duì)于單一傳輸類型最簡(jiǎn)系統(tǒng)，我們忽略復(fù)合設(shè)備的要求即可。compatibleID字段必須指定 "WINUSB" 作為字段值。其他可以根據(jù)需求更改。

3、注冊(cè)設(shè)備接口 GUID描述符：

該描述符用于區(qū)分不同的WinUSB設(shè)備。

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、端點(diǎn)描述符：

按實(shí)際的需求的配置端點(diǎn)數(shù)量和類型，即可完成嵌入式設(shè)備的描述符配置了。

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

圖1 成功枚舉為USB Device

如何編寫PC應(yīng)用程序與嵌入式設(shè)備進(jìn)行USB通信

PC機(jī)軟件相對(duì)來(lái)說(shuō)比較簡(jiǎn)單，并且微軟官方也給出了示例代碼。唯一需要注意的是，對(duì)應(yīng)的軟件程序獲取WinUSB設(shè)備句柄的GUID參數(shù)，需要與嵌入式設(shè)備的描述符中的GUID保持一致。GUID是WinUSB用以區(qū)分設(shè)備的唯一標(biāo)志。GUID，是Globally Unique Identifier的簡(jiǎn)稱，翻譯為全局唯一標(biāo)識(shí)符，是一種由算法生成的二進(jìn)制數(shù)據(jù)，長(zhǎng)度為128位的數(shù)字標(biāo)識(shí)符。

具體實(shí)現(xiàn)步驟如下：

1、創(chuàng)建設(shè)備的文件句柄：

調(diào)用 SetupDiGetClassDevs 獲取設(shè)備信息集的句柄；調(diào)用 SetupDiEnumDeviceInterfaces 枚舉設(shè)備信息集中的設(shè)備接口并獲取有關(guān)設(shè)備接口的信息；調(diào)用 SetupDiGetDeviceInterfaceDetail 獲取設(shè)備接口的詳細(xì)信息，所獲取的信息通過(guò)SP_DEVICE_INTERFACE_DETAIL_DATA結(jié)構(gòu)返回。由于該結(jié)構(gòu)大小無(wú)法提前獲取，故需連續(xù)兩次調(diào)用該函數(shù)，第二次調(diào)用時(shí)接口詳細(xì)信息將填充到根據(jù)第一次調(diào)用返回值所確定大小的該緩沖區(qū)，通過(guò)緩沖內(nèi)該結(jié)構(gòu)的DevicePath成員中可獲得“設(shè)備路徑”。

2、獲取設(shè)備的 WinUSB 接口句柄：

調(diào)用 WinUsb_Initialize通過(guò)傳遞在創(chuàng)建設(shè)備的文件句柄中創(chuàng)建的文件句柄。

3、查詢?cè)O(shè)備以獲取 USB 描述符：

接下來(lái)，查詢?cè)O(shè)備以獲取特定于 USB 的信息，如設(shè)備速度、接口描述符、相關(guān)端點(diǎn)及其管道。調(diào)用 WinUsb_QueryDeviceInformation 從設(shè)備的設(shè)備描述符請(qǐng)求信息。調(diào)用 WinUsb_QueryInterfaceSettings 并傳遞設(shè)備的接口句柄，以獲得對(duì)應(yīng)的接口描述符。調(diào)用 WinUsb_QueryPipe 獲取有關(guān)每個(gè)接口每個(gè)終結(jié)點(diǎn)的信息。此步驟不是必須的，因?yàn)槎它c(diǎn)方向及傳輸特性由嵌入式設(shè)備描述符決定，是已知的。

4、向默認(rèn)端點(diǎn)發(fā)送控制傳輸：

此步驟也不是必須的。一般都不通過(guò)默認(rèn)端點(diǎn)發(fā)送有效載荷。

5、發(fā)送 I/O 請(qǐng)求：

將數(shù)據(jù)發(fā)送到設(shè)備的批量輸入和批量輸出端點(diǎn)，這些端點(diǎn)點(diǎn)可分別用于讀取請(qǐng)求和寫入請(qǐng)求。調(diào)用 WinUsb_ReadPipe 從設(shè)備的批量輸入端點(diǎn)讀取數(shù)據(jù)。調(diào)用 WinUsb_WritePipe 通過(guò)批量輸出端點(diǎn)將數(shù)據(jù)寫入設(shè)備。在嵌入式設(shè)備的輸出端點(diǎn)內(nèi)寫入數(shù)據(jù)之后，就可以在PC端讀出數(shù)據(jù)。反之，如果在PC端對(duì)嵌入式設(shè)備的輸入端點(diǎn)寫入數(shù)據(jù)，則嵌入式設(shè)備會(huì)產(chǎn)生一個(gè)USB端點(diǎn)寫入事件，具體如何捕捉該事件，則由MCU廠家的產(chǎn)品硬件決定，產(chǎn)生相應(yīng)的中斷信息，供中斷服務(wù)程序來(lái)判斷。一般而言，芯片廠家會(huì)提供MCU的USB通信基礎(chǔ)范例程序，在其基礎(chǔ)上做簡(jiǎn)單的修改和適配即可。

6、釋放設(shè)備句柄

在完成對(duì)設(shè)備的所有必要的調(diào)用之后，釋放設(shè)備的文件句柄和 WinUSB 接口句柄。CloseHandle 釋放由 CreateFile 創(chuàng)建的句柄。

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

至此，已經(jīng)完成了嵌入式設(shè)備端固件的USB代碼移植和PC端應(yīng)用程序的編寫，就可以實(shí)現(xiàn)USB免驅(qū)設(shè)備的通信方式了