USB HID報告及報告描述簡介
在USB中,USB HOST是通過各種描述符來識別裝置的,有裝置描述符,配置描述符,介面描述符,端點描述符,字串描述符,報告描述符等等。USB報告描述符(Report Descriptor)是HID裝置中的一個描述符,它是比較複雜的一個描述符。
USB HID裝置是通過報告來給傳送資料的,報告有輸入報告和輸出報告。輸入報告是USB裝置傳送給主機的,例如USB滑鼠將滑鼠移動和滑鼠點選等資訊返回給電腦,鍵盤將按鍵資料資料返回給電腦等;輸出報告是主機發送給USB裝置的,例如鍵盤上的數字鍵盤鎖定燈和大寫字母鎖定燈等。報告是一個數據包,裡面包含的是所要傳送的資料。輸入報告是通過中斷輸入端點輸入的,而輸出報告有點區別,當沒有中斷輸出端點時,可以通過控制輸出端點0傳送,當有中斷輸出端點時,通過中斷輸出端點發出。
而報告描述符,是描述一個報告以及報告裡面的資料是用來幹什麼用的。通過它,USB HOST可以分析出報告裡面的資料所表示的意思。它通過控制輸入端點0返回,主機使用獲取報告描述符命令來獲取報告描述符,注意這個請求是傳送到介面的,而不是到裝置。一個報告描述符可以描述多個報告,不同的報告通過報告ID來識別,報告ID在報告最前面,即第一個位元組。當報告描述符中沒有規定報告ID時,報告中就沒有ID欄位,開始就是資料。更詳細的說明請參看USB HID協議,該協議可從Http://www.usb.org下載。
USB報告描述符可以通過使用HID Descriptor tool來生成,這個工具可以到
下面通過由HID Descriptor tool生成的USB滑鼠和USB鍵盤來說明一下報告描述符和報告。
code char KeyBoardReportDescriptor[63] = {
//表示用途頁為通用桌面裝置
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
//表示用途為鍵盤
0x09, 0x06, // USAGE (Keyboard)
//表示應用集合,必須要以END_COLLECTION來結束它,見最後的END_COLLECTION
0xa1, 0x01, // COLLECTION (Application)
//表示用途頁為按鍵
0x05, 0x07, // USAGE_PAGE (Keyboard)
//用途最小值,這裡為左ctrl鍵
0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
//用途最大值,這裡為右GUI鍵,即window鍵
0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
//邏輯最小值為0
0x15, 0x00, // LOGICAL_MINIMUM (0)
//邏輯最大值為1
0x25, 0x01, // LOGICAL_MAXIMUM (1)
//報告大小(即這個欄位的寬度)為1bit,所以前面的邏輯最小值為0,邏輯最大值為1
0x75, 0x01, // REPORT_SIZE (1)
//報告的個數為8,即總共有8個bits
0x95, 0x08, // REPORT_COUNT (8)
//輸入用,變數,值,絕對值。像鍵盤這類一般報告絕對值,
//而滑鼠移動這樣的則報告相對值,表示滑鼠移動多少
0x81, 0x02, // INPUT (Data,Var,Abs)
//上面這這幾項描述了一個輸入用的欄位,總共為8個bits,每個bit表示一個按鍵
//分別從左ctrl鍵到右GUI鍵。這8個bits剛好構成一個位元組,它位於報告的第一個位元組。
//它的最低位,即bit-0對應著左ctrl鍵,如果返回的資料該位為1,則表示左ctrl鍵被按下,
//否則,左ctrl鍵沒有按下。最高位,即bit-7表示右GUI鍵的按下情況。中間的幾個位,
//需要根據HID協議中規定的用途頁表(HID Usage Tables)來確定。這裡通常用來表示
//特殊鍵,例如ctrl,shift,del鍵等
//這樣的資料段個數為1
0x95, 0x01, // REPORT_COUNT (1)
//每個段長度為8bits
0x75, 0x08, // REPORT_SIZE (8)
//輸入用,常量,值,絕對值
0x81, 0x03, // INPUT (Cnst,Var,Abs)
//上面這8個bit是常量,裝置必須返回0
//這樣的資料段個數為5
0x95, 0x05, // REPORT_COUNT (5)
//每個段大小為1bit
0x75, 0x01, // REPORT_SIZE (1)
//用途是LED,即用來控制鍵盤上的LED用的,因此下面會說明它是輸出用
0x05, 0x08, // USAGE_PAGE (LEDs)
//用途最小值是Num Lock,即數字鍵鎖定燈
0x19, 0x01, // USAGE_MINIMUM (Num Lock)
//用途最大值是Kana,這個是什麼燈我也不清楚^_^
0x29, 0x05, // USAGE_MAXIMUM (Kana)
//如前面所說,這個欄位是輸出用的,用來控制LED。變數,值,絕對值。
//1表示燈亮,0表示燈滅
0x91, 0x02, // OUTPUT (Data,Var,Abs)
//這樣的資料段個數為1
0x95, 0x01, // REPORT_COUNT (1)
//每個段大小為3bits
0x75, 0x03, // REPORT_SIZE (3)
//輸出用,常量,值,絕對
0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
//由於要按位元組對齊,而前面控制LED的只用了5個bit,
//所以後面需要附加3個不用bit,設定為常量。
//報告個數為6
0x95, 0x06, // REPORT_COUNT (6)
//每個段大小為8bits
0x75, 0x08, // REPORT_SIZE (8)
//邏輯最小值0
0x15, 0x00, // LOGICAL_MINIMUM (0)
//邏輯最大值255
0x25, 0xFF, // LOGICAL_MAXIMUM (255)
//用途頁為按鍵
0x05, 0x07, // USAGE_PAGE (Keyboard)
//使用最小值為0
0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
//使用最大值為0x65
0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
//輸入用,變數,陣列,絕對值
0x81, 0x00, // INPUT (Data,Ary,Abs)
//以上定義了6個8bit寬的陣列,每個8bit(即一個位元組)用來表示一個按鍵,所以可以同時
//有6個按鍵按下。沒有按鍵按下時,全部返回0。如果按下的鍵太多,導致鍵盤掃描系統
//無法區分按鍵時,則全部返回0x01,即6個0x01。如果有一個鍵按下,則這6個位元組中的第一
//個位元組為相應的鍵值(具體的值參看HID Usage Tables),如果兩個鍵按下,則第1、2兩個
//位元組分別為相應的鍵值,以次類推。
//關集合,跟上面的對應
0xc0 // END_COLLECTION
};
通過上面的分析,我們知道這個報告中只有一個報告,所以沒有報告ID,因此返回的都是實際使用的資料。總共有8位元組輸入,1位元組輸出。其中輸入的第一位元組用來表示特殊按鍵,第二位元組保留,後面的六位元組為普通按鍵。如果只有左ctrl鍵按下,則返回01 00 00 00 00 00 00 00(十六進位制),如果只有數字鍵1 按下,則返回00 00 59 00 00 00 00 00,如果數字鍵1 和2 同時按下,則返回00 00 59 5A 00 00 00 00,如果再按下左shift 鍵,則返回02 00 59 5A 00 00 00 00,然後再釋放1 鍵,則返回02 00 5A 00 00 00 00 00,然後全部按鍵釋放,則返回00 00 00 00 00 00 00 00。這些資料(即報告)都是通過中斷端點返回的。當按下Num Lock鍵時,PC會發送輸出報告,從報告描述符中我們知道,Num Lock的LED對應著輸出報告的最低位,當數字小鍵盤開啟時,輸出xxxxxxx1(二進位制,打x的由其它的LED狀態決定);當數字小鍵盤關閉時,輸出xxxxxxx0(同前)。取出最低位就可以控制數字鍵鎖定LED了。
下面這個報告描述符是USB滑鼠報告描述符,比起鍵盤的來說要簡單些。它描述了4個位元組,第一個位元組表示按鍵,第二個位元組表示x軸(即滑鼠左右移動,0表示不動,正值表示往右移,負值表示往左移),第三個位元組表示y軸(即滑鼠上下移動,0表示不動,正值表示往下移動,負值表示往上移動),第四個位元組表示滑鼠滾輪(正值為往上滾動,負值為往下滾動)。
code char MouseReportDescriptor[52] = {
//通用桌面裝置
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
//滑鼠
0x09, 0x02, // USAGE (Mouse)
//集合
0xa1, 0x01, // COLLECTION (Application)
//指標裝置
0x09, 0x01, // USAGE (Pointer)
//集合
0xa1, 0x00, // COLLECTION (Physical)
//按鍵
0x05, 0x09, // USAGE_PAGE (Button)
//使用最小值1
0x19, 0x01, // USAGE_MINIMUM (Button 1)
//使用最大值3。1表示左鍵,2表示右鍵,3表示中鍵
0x29, 0x03, // USAGE_MAXIMUM (Button 3)
//邏輯最小值0
0x15, 0x00, // LOGICAL_MINIMUM (0)
//邏輯最大值1
0x25, 0x01, // LOGICAL_MAXIMUM (1)
//數量為3
0x95, 0x03, // REPORT_COUNT (3)
//大小為1bit
0x75, 0x01, // REPORT_SIZE (1)
//輸入,變數,數值,絕對值
//以上3個bit分別表示滑鼠的三個按鍵情況,最低位(bit-0)為左鍵
//bit-1為右鍵,bit-2為中鍵,按下時對應的位值為1,釋放時對應的值為0
0x81, 0x02, // INPUT (Data,Var,Abs)
//填充5個bit,補足一個位元組
0x95, 0x01, // REPORT_COUNT (1)
0x75, 0x05, // REPORT_SIZE (5)
0x81, 0x03, // INPUT (Cnst,Var,Abs)
//用途頁為通用桌面
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
//用途為X
0x09, 0x30, // USAGE (X)
//用途為Y
0x09, 0x31, // USAGE (Y)
//用途為滾輪
0x09, 0x38, // USAGE (Wheel)
//邏輯最小值為-127
0x15, 0x81, // LOGICAL_MINIMUM (-127)
//邏輯最大值為+127
0x25, 0x7f, // LOGICAL_MAXIMUM (127)
//大小為8個bits
0x75, 0x08, // REPORT_SIZE (8)
//數量為3個,即分別代表x,y,滾輪
0x95, 0x03, // REPORT_COUNT (3)
//輸入,變數,值,相對值
0x81, 0x06, // INPUT (Data,Var,Rel)
//關集合
0xc0, // END_COLLECTION
0xc0 // END_COLLECTION
};
通過對上面的報告分析,我們知道報告返回4個位元組,沒有報告ID。如果滑鼠左鍵按下,則返回01 00 00 00(十六進位制值),如果右鍵按下,則返回02 00 00 00,如果中鍵按下,則返回04 00 00 00,如果三個鍵同時按下,則返回07 00 00 00。如果滑鼠往右移動則第二位元組返回正值,值越大移動速度越快。其它的類推。
這裡只對報告描述符做一個簡單的介紹,更詳細的資料請參看USB HID協議以及HID Usage Tables,可以從Http://www.usb.org下載。