在前面的文章中,我們已經(jīng)給出了USB協(xié)議的鏈接地址,從這篇文章起,我們會涉及到許多USB 1.1的內(nèi)容,我們的指導(dǎo)思想是先從熟悉USB 1.1協(xié)議入手,先使用現(xiàn)成的HCD和USBD,直接面對客戶端驅(qū)動編程,盡快看到成果,使讀者對USB的開發(fā)充滿信心,進(jìn)而去研究USBD和HCD的編程方法。請讀者自行閱讀協(xié)議,文章中有關(guān)協(xié)議的詳細(xì)情況,由于會涉及非常多的文字,恕不能過多解釋。
1、USB系統(tǒng)主機端的軟件結(jié)構(gòu)
一般來說,教科書或者協(xié)議上都會把USB主機端的軟件說成有三層,第一層叫主機控制器驅(qū)動程序HCD(Host Controller Driver),第二層叫USB驅(qū)動程序USBD(USB Driver),第三層叫客戶端驅(qū)動程序(Client Driver);實際上,我們實際看到的東西,往往HCD和USBD是由一個程序完成的,比如windows就提供了HCD和USBD,如果你自己開發(fā)了一個USB設(shè)備,只需要在HCD和USBD上面開發(fā)一個客戶端驅(qū)動程序即可;linux也是同樣,linux內(nèi)核已經(jīng)提供了HCD和USBD;所以在windows和linux下我們基本上沒有開發(fā)HCD和USBD的必要,而且linux還提供源代碼;但DOS就不一樣了,DOS本身對USB沒有任何支持,所以要想在DOS下徹底玩轉(zhuǎn)USB,需要研究HCD、USBD和客戶端驅(qū)動程序。
2、DOSUSB介紹
很顯然,HCD和USBD更加底層一些,需要理解的東西也更多一些;如果我們能夠繞過HCD和USBD,直接從客戶端驅(qū)動程序入手,將會容易許多。幸運的是我們可以找到一個免費的DOS下的USB驅(qū)動程序,叫DOSUSB,該驅(qū)動程序?qū)崿F(xiàn)了大部分的HCD和USBD的功能,使我們進(jìn)行USB編程的好幫手。
DOSUSB目前還沒有實現(xiàn)EHIC的驅(qū)動,也就是說還不支持USB2.0,這也是我們從USB 1.1開始的原因之一,另一方面,由于USB2.0是兼容USB1.1的,所以,即便你在USB2.0的設(shè)備下,仍然可以使用USB1.1的驅(qū)動程序,只不過不能實現(xiàn)480MB/秒的傳送速度而已。
下面我們介紹一下DOSUSB。DOSUSB的官方網(wǎng)站如下:
http://www.usbdos.net
可以從其官方網(wǎng)站上下載DOGUSB的最新版本,當(dāng)前版本是1.1.1。或者在下面在下面網(wǎng)址下載這個版本的DOSUSB。
http://blog.hengch.com/software/dosusb/dosusb.zip
DOSUSB可以在非商業(yè)領(lǐng)域免費使用,如果肯花費費用,可以購買到源代碼,從其官方網(wǎng)站的論壇上看到,在2006年9月作者開出的源代碼的價格是1000歐元。
DOSUSB的安裝十分簡便,只需要解壓縮到某一個目錄下即可,比如放在c:\dosusb目錄下,請自行閱讀DOSUSB自帶的文檔,使用也非常簡單,在DOS提示符下鍵入dosusb執(zhí)行即可。
c:\dosusb>dosusb
缺省情況下,DOSUSB使用int 65h作為其驅(qū)動的調(diào)用軟中斷,如果和你的系統(tǒng)有沖突,在運行dosusb時可以加參數(shù)/I,請自行閱讀DOSUSB的文檔。
DOSUSB通過一個叫做URB(USB Request Block)的數(shù)據(jù)結(jié)構(gòu)與客戶端驅(qū)動程序進(jìn)行通訊,這一點和linux非常相似,估計作者參考了linux下的源代碼,在DOSUSB文檔里給出了這個結(jié)構(gòu)的定義,如下:
struct {
BYTE transaction_type; // 設(shè)置事務(wù)(控制傳輸)(2Dh),輸入事務(wù)(69h)輸出事務(wù)(E1h)
BYTE chain_end_flag; // 備用
BYTE dev_add; // 設(shè)備地址
BYTE end_point; // 端點號
BYTE error_code; // 錯誤嗎
BYTE status; // 設(shè)備狀態(tài)
WORD transaction_flags; // 備用
WORD buffer_off; // 接收/發(fā)送緩沖區(qū)偏移地址
WORD buffer_seg; // 接收/發(fā)送緩沖區(qū)段地址
WORD buffer_length; // 接收/發(fā)送緩沖區(qū)長度
WORD actual_length; // 接收/發(fā)送時每個包的最大長度
WORD setup_buffer_off; // setup_request結(jié)構(gòu)的偏移地址
WORD setup_buffer_seg; // setup_request結(jié)構(gòu)的段地址
WORD start_frame; // 備用
WORD nr_of_packets; // >0時會啟動實時傳輸
WORD int_interval; // 備用
WORD error_count; // 重試的次數(shù)
WORD timeout; // 備用
WORD next_urb_off; // 備用
WORD next_urb_seg; // 備用
} urb // 32字節(jié)
之所以列出這個結(jié)構(gòu),是因為我們將使用這個結(jié)構(gòu)與USBD進(jìn)行交互。關(guān)于結(jié)構(gòu)中字段的定義,在DOSUSB的文檔中有詳細(xì)的說明。除備用字段不需要填以外,error_code和status由DOSUSB返回,故填0即可,后面還會介紹更詳細(xì)的填寫方法。
在DOSUSB的發(fā)行包中,有一個sample目錄,里面有很多例子,但大多是使用power basic寫的,不過仍然有很好的參考價值。
3、USB 1.1協(xié)議中的一些內(nèi)容
USB協(xié)議為USB設(shè)備定義了一套描述設(shè)備功能和屬性的固有結(jié)構(gòu)的描述符,包括標(biāo)準(zhǔn)描述符(設(shè)備描述符、培植描述符、接口描述符、端點描述符和字符串描述符),還有費標(biāo)準(zhǔn)描述符,如類描述符等。按照協(xié)議,設(shè)備描述符下可以有若干個配置描述符,每個配置描述符可以有若干個接口描述符,每個接口描述符下又可以有若干個端點描述符,字符串描述符主要用于描述一些文字信息,比如廠家名稱,產(chǎn)品名稱等。這篇文章的目的就是要讀出這些描述符。
實際上,所謂描述符就是一個數(shù)據(jù)結(jié)構(gòu),不管是什么描述符,其前兩個字節(jié)的含義都是一樣的,第一個字節(jié)是描述符的長度,第二個字節(jié)是描述符的類型。
- 設(shè)備描述符(Device Descriptor):
struct {
BYTE bLength; // 描述符的長度,以字節(jié)為單位
BYTE bDescriptorType; // 設(shè)備描述符類型,0x01
WORD bcdUSB; // 設(shè)備支持的USB協(xié)議版本,BCD碼
BYTE bDeviceClass; // 設(shè)備類代碼(由USB-IF分配)
BYTE bDeviceSubClass; // 子類代碼
BYTE bDeviceProtocol; // 協(xié)議碼
BYTE bMaxPacketSize0; // 端點0的最大包長度(僅為8,16,32,64)
WORD idVendor; // 廠商ID(由USB-IF分配)
WORD idProduct; // 產(chǎn)品ID(由制造商定義)
WORD bcdDevice; // 設(shè)備發(fā)行號(BCD碼)
BYTE iManufacture; // 描述廠商信息的字符串描述符的索引值
BYTE iProduct; // 描述產(chǎn)品信息的字符串描述符的索引值
BYTE iSerialNumber; // 描述設(shè)備序列號信息的字符串描述符的索引值
BYTE bNumConfigurations; // 可能的配置描述符的數(shù)目
} device_descriptor
- 配置描述符(Configuration Descriptor)
struct {
BYTE bLength; // 描述符的長度,以字節(jié)為單位
BYTE bDescriptorType; // 配置描述符類型,0x02
WORD wTotalLength; // 配置信息的總長
BYTE bNumInterfaces; // 該配置所支持的接口數(shù)目
BYTE bConfigurationValue; // 被SetCongiguration()請求用做參數(shù)來選定該配置
BYTE bConfiguration; // 描述該配置的字符串描述符的索引值
BYTE bmAttributes; // 配置特性
BYTE MaxPower; // 該配置下的總線電源耗費量,以2mA為一個單位
}configuration_descriptor;
bmAttributes :b7:備用,b6:自供電,b5:遠(yuǎn)程喚醒,b4--b0:備用
另外,在讀取配置描述符時可以把該配置下的所有描述符全部讀出,這些描述符的總長度就是wTotalLength字段的值,讀出所有描述符后,在一個一個地拆分。
- 接口描述符(Interface Descriptor):
struct {
BYTE bLength; // 描述符的長度,以字節(jié)為單位
BYTE bDescriptorType; // 接口描述符類型,0x04
BYTE bInterfaceNumber; // 接口號,從0開始
BYTE bAlternateSetting; // 可選設(shè)置的索引值.
BYTE bNumEndpoints; // 此接口的端點數(shù)量。
BYTE bInterfaceClass; // 接口類編碼(由USB-IF分配)
BYTE bInterfaceSubClass; // 接口子類編碼(由USB-IF分配)
BYTE bInterfaceProtocol; // 協(xié)議碼(由USB-IF分配)
BYTE iInterface; // 描述該接口的字符串描述符的索引值
}interface_descriptor;
bInterfaceClass:USB協(xié)議根據(jù)功能將不同的接口劃分成不同的類,如下:
1:音頻類,2:CDC控制類,3:人機接口類(HID),5:物理類,6:圖像類,7:打印機類,8:大數(shù)據(jù)存儲類,9:集線器類,10:CDC數(shù)據(jù)類,11:智能卡類,13:安全類,220:診斷設(shè)備類,224:無線控制類,254:特定應(yīng)用類,255廠商定義的設(shè)備。
- 端點描述符(Endpoint Descriptor):
struct {
BYTE bLength; // 描述符的長度,以字節(jié)為單位
BYTE bDescriptorType; // 端點描述符類型,0x05
BYTE bEndpointAddress; // 端點地址
BYTE bmAttributes; // 在bconfigurationValue所指的配置下的端點特性.
WORD wMaxPacketSize; // 接收/發(fā)送的最大數(shù)據(jù)報長度.
BYTE bInterval; // 周期數(shù)據(jù)傳輸端點的時間間隙.
}endpoint_descriptor;
bmAttributes:bit 1:0--傳送類型,00=控制傳輸,01=實時傳輸,10=批量傳輸,11=中斷傳輸;所有其他位均保留。
- 字符串描述符(String Descriptor):
struct {
BYTE bLength; // 描述符的長度,以字節(jié)為單位
BYTE bDescriptorType; // 字符串描述符類型,0x03
char bString[]; // UNICODE編碼的字符串
}string_descriptor;
- USB命令請求(USB DEVICE REQUEST)
為了更好地協(xié)調(diào)USB主機與設(shè)備之間的數(shù)據(jù)通信,USB規(guī)范定義了一套命令請求,用于完成主機對總線上所有USB設(shè)備的統(tǒng)一控制,USB命令請求由統(tǒng)一的格式,其結(jié)構(gòu)如下:
struct {
BYTE bmRequestType; // 請求類型
BYTE bRequest; // 命令請求的編碼
WORD wValue; // 命令不同,含義不同
WORD wIndex; // 命令不同,含義不同
WORD wLength; // 如果有數(shù)據(jù)階段,此字段為數(shù)據(jù)字節(jié)數(shù)
} setup_request;
后面我們向設(shè)備發(fā)出指令就全靠這個結(jié)構(gòu)了。作為我們本文要用到的讀取USB設(shè)備描述符的命令請求,該結(jié)構(gòu)各字段的填法如下。
bmRequestType : b7--數(shù)據(jù)傳輸方向,0=主機到設(shè)備,1=設(shè)備到主機;b6:5--命令的類型,0=標(biāo)準(zhǔn)命令,1=類命令,2=廠商提供的命令,3=保留;b4:0--接收對象,0=設(shè)備,1=接口,2=端點,3=其他。我們發(fā)出的得到描述符的命令,數(shù)據(jù)傳輸方向為設(shè)備到主機,標(biāo)準(zhǔn)命令,接收對象為設(shè)備,所以該字段填0x80。
bRequest : 標(biāo)準(zhǔn)命令的編碼如下,GET_STATUS=0;CLEAR_FEATURE=1;SET_FEATURE=3;SET_ADDRESS=5;GET_DESCRIPTOR=6;SET_DESCRIPTOR=7;GET_CONFIGURATION=8;SET_CONFIGURATION=9;GET_INTERFACE=10;SET_INTERFACE=11;SYNCH_FRAME=12。我們的命令是GET_DESCRIPTOR,所以應(yīng)該填6。
wValue : 高字節(jié)表示描述符的類型,0x01=設(shè)備描述符,0x02=配置描述符,0x03=字符串描述符,0x04=接口描述符,0x05=端點描述符,0x29=集線器類描述符,0x21=人機接口類描述符,0xFF=廠商定義的描述符。
低字節(jié)表示表示描述符的索引值。所以,當(dāng)讀取設(shè)備描述符時,該字段值為0x100,當(dāng)讀取配置描述符是,應(yīng)為0x03yy,其中yy為描述符的索引值。
wIndex : 當(dāng)讀取字符串描述符時,填0x0409,表示希望獲得英文字符串,其他情況下填0。
wLength : 數(shù)據(jù)長度,一般應(yīng)該填寫,描述符的第一個字節(jié),bLength。由于我們在讀描述符時,并不知道其實際長度,通常的做法是先讀取8個字節(jié),然后根據(jù)第一個字節(jié)bLength的值在重新讀取一次完整的描述符;注意,當(dāng)讀取配置描述符的錢8個字節(jié)后,應(yīng)該使用wTotalLength字段的值作為長度讀取與該配置有關(guān)的所有描述符。
4、讀取設(shè)備描述符的范例程序
按照我們文章的習(xí)慣,幾乎每篇文章都有一個范例程序,本文也不例外,本文的范例程序請在下面地址下載:
http://blog.hengch.com/source/usbview.zip
程序用C++寫成,在DJGPP下編譯通過,所以是32位保護(hù)模式下的代碼,要注意的是,DOSUSB是實模式下的驅(qū)動,所以在申請內(nèi)存塊時要申請1M以內(nèi)實模式可以讀取的內(nèi)存,否則,在使用int 65h調(diào)用DOSUSB時一定會出現(xiàn)問題。
有4個頭文件,public.h中定義了一些方便使用的數(shù)據(jù)類型,比如BYTE為char,WORD為short int等等,可以不必太關(guān)注;x86int.h中定義了調(diào)用DOS中斷所需的函數(shù)和數(shù)據(jù)結(jié)構(gòu),直到怎么使用就可以了;dosmem.h中定義了一個DOS_MEM類,主要是為了在保護(hù)模式下申請和使用DOS內(nèi)存塊更為方便,也是知道其中的方法,能夠明白程序中的意義就可以了;usb.h定義了與USB協(xié)議有關(guān)的所有常數(shù),這些常數(shù)與前面介紹的各種數(shù)據(jù)結(jié)構(gòu)一一對應(yīng),由于我們是在保護(hù)模式下使用DOS內(nèi)存,所以把一個內(nèi)存塊映射到一個數(shù)據(jù)結(jié)構(gòu)上有一些麻煩,讀取各個字段主要靠在usb.h中定義的這些常數(shù)。
主要程序在usbview.cc中,主要思路如下:
- USB設(shè)備的地址從1--127,所以我們從1--127做一個循環(huán),逐一讀取USB設(shè)備描述符,直到出現(xiàn)“非法地址”為止。
- 每一個USB設(shè)備的設(shè)備描述符只有一個,所以我們從讀取某個地址下的設(shè)備描述符開始。
- 開始我們并不知道設(shè)備描述符的長度,即便我們知道其長度為18個字符,但我們?nèi)匀徊恢蓝它c0允許的包長度(設(shè)備描述符中bMaxPacketSize0字段),但我們知道包長度的最小值是8,所以我們先讀取8個字節(jié)的設(shè)備描述符。
- 在我們得到8個字符的設(shè)備描述符后,我們就可以得到該描述符的長度和端點0的包長度,在后面發(fā)出的所有命令中,始終要把這個值填在URB結(jié)構(gòu)的actual_length字段中。
- buffer用于存放USBD返回的描述符,在使用前建議初始化一下,全部清0。
- 要向設(shè)備發(fā)出命令請求(Request),需要先填setup_request結(jié)構(gòu),前面講過,bmRequestType=0x80,bRequest=6,這兩個字段的填法始終不變;我們現(xiàn)在讀取設(shè)備描述符,所以wValue=0x100,wIndex=0,wLength在首次調(diào)用時填8,第二次調(diào)用時填返回的bLength字段(應(yīng)該是18)。
- 準(zhǔn)備好buffer和setup_request后,我們要填URB一邊與DOSUSB交互;讀取描述符是一個控制傳輸,所以transaction=0x2D(后面一直是0x2D);dev_add填上面提到的循環(huán)變量;end_point=0,因為我們總對端點0(見USB協(xié)議);buffer_off和buffer_seg分別填buffer的便宜地址和段地址;setup_buffer_off和setup_buffer_seg分別填前面setup_request結(jié)構(gòu)的偏移地址和段地址;buffer_length同setup_request結(jié)構(gòu)中的wLength,也可以把值設(shè)在wLength和buferr的最大長度之間,如果buffer的最大長度小于wLength,我們只能填buffer的最大長度,但這種情況下我們將得不到完整的描述符;actual_length在第一次調(diào)用時填8,以后一直填返回的bMaxPacketsize0字段;其他字段均為0。
- 讓DS:DX指向剛剛填完的URB結(jié)構(gòu),調(diào)用軟中斷65h,DOSUSB將為你處理下面的事情。
- 如果正常,error_code應(yīng)該返回0,如果非0,含義如下:
1--非法的設(shè)備地址;2--內(nèi)部錯誤;3--非法的transation_type字段;4--非法的buffer長度。
- 如果正常,status字段應(yīng)該為0,該字段是是USB控制器返回的狀態(tài)字節(jié),不同的控制器(OHCI或UHCI)會返回不同的值。
- 當(dāng)我們得到設(shè)備描述符后,如果設(shè)備描述符中的iManufacturer字段不為0,我們可以根據(jù)這個所引值得到相應(yīng)的字符串描述符,從而顯示出廠家信息,要注意的是字符串描述符是UNICODE編碼,對于ASCII而言,它是一個ASSCII碼跟一個ASCII 0組成;同理我們可以得到產(chǎn)品信息和序列號信息。
- 當(dāng)我們得到了設(shè)備的設(shè)備描述符后,我們就可以知道這個設(shè)備上有多少個配置(設(shè)備描述符中的bNumConfigurations),進(jìn)而通過一個循環(huán)得到所有的配置描述符及其配置下的所有描述符。
- 讀取配置描述符的方法與讀取設(shè)備描述符大同小異,也是先讀取8個字節(jié),然后根據(jù)返回的內(nèi)容再讀取所有的描述符內(nèi)容,要注意的是,實際上,我們不能單獨得到接口描述符和端點描述符,唯一的辦法是把一個配置下的描述符全部讀出來,所以setup_request結(jié)構(gòu)中的wLength字段一定要與配置描述符中返回的wTotalLength值一致才行。
- 剩下的事情就是如何顯示我們得到的描述符,我想這對每一位讀者而言都不是什么困難的事。