/******************************************************************
   本程序只供學習使用，未經作者許可，不得用于其它任何用途
			
        歡迎訪問我的USB專區：http://group.ednchina.com/93/
        歡迎訪問我的blog：   http://www.ednchina.com/blog/computer00
                             http://computer00.21ic.org

        感謝PCB贊助商——電子園： http://bbs.cepark.com/

UsbCore.c file

作者：電腦圈圈
建立日期: 2008.06.29
修改日期: 2008.07.14
版本：V1.1
版權所有，盜版必究。
Copyright(C) 電腦圈圈 2008-2018
All rights reserved            
*******************************************************************/

#include "config.h"
#include "pdiusbd12.h"
#include "uart.h"
#include "usbcore.h"
#include "led.h"

idata uint8 Buffer[16];  //讀端點0用的緩沖區

//USB設備請求的各字段
uint8  bmRequestType;
uint8  bRequest;
uint16 wValue;
uint16 wIndex;
uint16 wLength;
//當前發送數據的位置
uint8 * pSendData;
//需要發送數據的長度
uint16 SendLength;
//是否需要發送0數據包的標志。在USB控制傳輸的數據過程中，
//當返回的數據包字節數少于最大包長時，會認為數據過程結束。
//當請求的字節數比實際需要返回的字節數長，而實際返回的字節
//數又剛好是端點0大小的整數倍時，就需要返回一個0長度的數據包
//來結束數據過程。因此這里增加一個標志，供程序決定是否需要返回
//一個0長度的數據包。
uint8 NeedZeroPacket;

//當前的配置值。只有在設置非0配置后
uint8 ConfigValue;

//端點1緩沖是否忙的標志。當緩沖區中有數據時，該標志為真。
//當緩沖區中空閑時，該標志為假。
uint8 Ep1InIsBusy;

//USB設備描述符的定義
code uint8 DeviceDescriptor[0x12]=  //設備描述符為18字節
{
//bLength字段。設備描述符的長度為18(0x12)字節
 0x12,
 
//bDescriptorType字段。設備描述符的編號為0x01
 0x01,
 
//bcdUSB字段。這里設置版本為USB1.1，即0x0110。
//由于是小端結構，所以低字節在先，即0x10，0x01。
 0x10,
 0x01,
 
//bDeviceClass字段。我們不在設備描述符中定義設備類，
//而在接口描述符中定義設備類，所以該字段的值為0。
 0x00,
 
//bDeviceSubClass字段。bDeviceClass字段為0時，該字段也為0。
 0x00,
 
//bDeviceProtocol字段。bDeviceClass字段為0時，該字段也為0。
 0x00,
 
//bMaxPacketSize0字段。PDIUSBD12的端點0大小的16字節。
 0x10,
 
//idVender字段。廠商ID號，我們這里取0x8888，僅供實驗用。
//實際產品不能隨便使用廠商ID號，必須跟USB協會申請廠商ID號。
//注意小端模式，低字節在先。
 0x88,
 0x88,
 
//idProduct字段。產品ID號，由于是第二個實驗，我們這里取0x0002。
//注意小端模式，低字節應該在前。
 0x02,
 0x00,
 
//bcdDevice字段。我們這個USB鍵盤剛開始做，就叫它1.0版吧，即0x0100。
//小端模式，低字節在先。
 0x00,
 0x01,
 
//iManufacturer字段。廠商字符串的索引值，為了方便記憶和管理，
//字符串索引就從1開始吧。
 0x01,

//iProduct字段。產品字符串的索引值。剛剛用了1，這里就取2吧。
//注意字符串索引值不要使用相同的值。
 0x02,
 
//iSerialNumber字段。設備的序列號字符串索引值。
//這里取3就可以了。
 0x03,

//bNumConfigurations字段。該設備所具有的配置數。
//我們只需要一種配置就行了，因此該值設置為1。
 0x01
};
//////////////////////////設備描述符完畢//////////////////////////////

//USB報告描述符的定義
code uint8 ReportDescriptor[]=
{
 //每行開始的第一字節為該條目的前綴，前綴的格式為：
 //D7~D4：bTag。D3~D2：bType；D1~D0：bSize。以下分別對每個條目注釋。
 
 //這是一個全局（bType為1）條目，將用途頁選擇為普通桌面Generic Desktop Page(0x01)
 //后面跟一字節數據（bSize為1），后面的字節數就不注釋了，
 //自己根據bSize來判斷。
 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
 
 //這是一個局部（bType為2）條目，說明接下來的集合用途用于鍵盤
 0x09, 0x06, // USAGE (Keyboard)
 
 //這是一個主條目（bType為0）條目，開集合，后面跟的數據0x01表示
 //該集合是一個應用集合。它的性質在前面由用途頁和用途定義為
 //普通桌面用的鍵盤。
 0xa1, 0x01, // COLLECTION (Application)
 
 //這是一個全局條目，選擇用途頁為鍵盤（Keyboard/Keypad(0x07)）
 0x05, 0x07, //     USAGE_PAGE (Keyboard/Keypad)

 //這是一個局部條目，說明用途的最小值為0xe0。實際上是鍵盤左Ctrl鍵。
 //具體的用途值可在HID用途表中查看。
 0x19, 0xe0, //     USAGE_MINIMUM (Keyboard LeftControl)
 
 //這是一個局部條目，說明用途的最大值為0xe7。實際上是鍵盤右GUI鍵。
 0x29, 0xe7, //     USAGE_MAXIMUM (Keyboard Right GUI)
 
 //這是一個全局條目，說明返回的數據的邏輯值（就是我們返回的數據域的值）
 //最小為0。因為我們這里用Bit來表示一個數據域，因此最小為0，最大為1。
 0x15, 0x00, //     LOGICAL_MINIMUM (0)
 
 //這是一個全局條目，說明邏輯值最大為1。
 0x25, 0x01, //     LOGICAL_MAXIMUM (1)
 
 //這是一個全局條目，說明數據域的數量為八個。
 0x95, 0x08, //     REPORT_COUNT (8)
 
 //這是一個全局條目，說明每個數據域的長度為1個bit。
 0x75, 0x01, //     REPORT_SIZE (1)
 
 //這是一個主條目，說明有8個長度為1bit的數據域（數量和長度
 //由前面的兩個全局條目所定義）用來做為輸入，
 //屬性為：Data,Var,Abs。Data表示這些數據可以變動，Var表示
 //這些數據域是獨立的，每個域表示一個意思。Abs表示絕對值。
 //這樣定義的結果就是，當某個域的值為1時，就表示對應的鍵按下。
 //bit0就對應著用途最小值0xe0，bit7對應著用途最大值0xe7。
 0x81, 0x02, //     INPUT (Data,Var,Abs)
 
 //這是一個全局條目，說明數據域數量為1個
 0x95, 0x01, //     REPORT_COUNT (1)
 
 //這是一個全局條目，說明每個數據域的長度為8bit。
 0x75, 0x08, //     REPORT_SIZE (8)
 
 //這是一個主條目，輸入用，由前面兩個全局條目可知，長度為8bit，
 //數量為1個。它的屬性為常量（即返回的數據一直是0）。
 //該字節是保留字節（保留給OEM使用）。
 0x81, 0x03, //     INPUT (Cnst,Var,Abs)
 
 //這是一個全局條目。定義位域數量為6個。
 0x95, 0x06, //   REPORT_COUNT (6)
 
 //這是一個全局條目。定義每個位域長度為8bit。
 //其實這里這個條目不要也是可以的，因為在前面已經有一個定義
 //長度為8bit的全局條目了。
 0x75, 0x08, //   REPORT_SIZE (8)
 
 //這是一個全局條目，定義邏輯最小值為0。
 //同上，這里這個全局條目也是可以不要的，因為前面已經有一個
 //定義邏輯最小值為0的全局條目了。
 0x15, 0x00, //   LOGICAL_MINIMUM (0)
 
 //這是一個全局條目，定義邏輯最大值為255。
 0x25, 0xFF, //   LOGICAL_MAXIMUM (255)
 
 //這是一個全局條目，選擇用途頁為鍵盤。
 //前面已經選擇過用途頁為鍵盤了，所以該條目不要也可以。
 0x05, 0x07, //   USAGE_PAGE (Keyboard/Keypad)
 
 //這是一個局部條目，定義用途最小值為0（0表示沒有鍵按下）
 0x19, 0x00, //   USAGE_MINIMUM (Reserved (no event indicated))
 
 //這是一個局部條目，定義用途最大值為0x65
 0x29, 0x65, //   USAGE_MAXIMUM (Keyboard Application)
 
 //這是一個主條目。它說明這六個8bit的數據域是輸入用的，
 //屬性為：Data,Ary,Abs。Data說明數據是可以變的，Ary說明
 //這些數據域是一個數組，即每個8bit都可以表示某個鍵值，
 //如果按下的鍵太多（例如超過這里定義的長度或者鍵盤本身無法
 //掃描出按鍵情況時），則這些數據返回全1（二進制），表示按鍵無效。
 //Abs表示這些值是絕對值。
 0x81, 0x00, //     INPUT (Data,Ary,Abs)

 //以下為輸出報告的描述
 //邏輯最小值前面已經有定義為0了，這里可以省略。 
 //這是一個全局條目，說明邏輯值最大為1。
 0x25, 0x01, //     LOGICAL_MAXIMUM (1)
 
 //這是一個全局條目，說明數據域數量為5個。 
 0x95, 0x05, //   REPORT_COUNT (5)
 
 //這是一個全局條目，說明數據域的長度為1bit。
 0x75, 0x01, //   REPORT_SIZE (1)
 
 //這是一個全局條目，說明使用的用途頁為指示燈（LED）
 0x05, 0x08, //   USAGE_PAGE (LEDs)
 
 //這是一個局部條目，說明用途最小值為數字鍵盤燈。
 0x19, 0x01, //   USAGE_MINIMUM (Num Lock)
 
 //這是一個局部條目，說明用途最大值為Kana燈。
 0x29, 0x05, //   USAGE_MAXIMUM (Kana)
 
 //這是一個主條目。定義輸出數據，即前面定義的5個LED。
 0x91, 0x02, //   OUTPUT (Data,Var,Abs)
 
 //這是一個全局條目。定義位域數量為1個。
 0x95, 0x01, //   REPORT_COUNT (1)
 
 //這是一個全局條目。定義位域長度為3bit。
 0x75, 0x03, //   REPORT_SIZE (3)
 
 //這是一個主條目，定義輸出常量，前面用了5bit，所以這里需要
 //3個bit來湊成一字節。
 0x91, 0x03, //   OUTPUT (Cnst,Var,Abs)
 
 //下面這個主條目用來關閉前面的集合。bSize為0，所以后面沒數據。
 0xc0        // END_COLLECTION
};
//通過上面的報告描述符的定義，我們知道返回的輸入報告具有8字節。
//第一字節的8個bit用來表示特殊鍵是否按下（例如Shift、Alt等鍵）。
//第二字節為保留值，值為常量0。第三到第八字節是一個普通鍵鍵值的
//數組，當沒有鍵按下時，全部6個字節值都為0。當只有一個普通鍵按下時，
//這六個字節中的第一字節值即為該按鍵的鍵值（具體的鍵值請看HID的
//用途表文檔），當有多個普通鍵同時按下時，則同時返回這些鍵的鍵值。
//如果按下的鍵太多，則這六個字節都為0xFF（不能返回0x00，這樣會讓
//操作系統認為所有鍵都已經釋放）。至于鍵值在數組中的先后順序是
//無所謂的，操作系統會負責檢查是否有新鍵按下。我們應該在中斷端點1
//中按照上面的格式返回實際的鍵盤數據。另外，報告中還定義了一個字節
//的輸出報告，是用來控制LED情況的。只使用了低7位，高1位是保留值0。
//當某位的值為1時，則表示對應的LED要點亮。操作系統會負責同步各個
//鍵盤之間的LED，例如你有兩塊鍵盤，一塊的數字鍵盤燈亮時，另一塊
//也會跟著亮。鍵盤本身不需要判斷各種LED應該何時亮，它只是等待主機
//發送報告給它，然后根據報告值來點亮相應的LED。我們在端點1輸出中斷
//中讀出這1字節的輸出報告，然后對它取反（因為學習板上的LED是低電平時
//亮），直接發送到LED上。這樣main函數中按鍵點亮LED的代碼就不需要了。
///////////////////////////報告描述符完畢////////////////////////////

//USB配置描述符集合的定義
//配置描述符總長度為9+9+9+7+7字節
code uint8 ConfigurationDescriptor[9+9+9+7+7]=
{
 /***************配置描述符***********************/
 //bLength字段。配置描述符的長度為9字節。
 0x09,
 
 //bDescriptorType字段。配置描述符編號為0x02。
 0x02,
 
 //wTotalLength字段。配置描述符集合的總長度，
 //包括配置描述符本身、接口描述符、類描述符、端點描述符等。
 sizeof(ConfigurationDescriptor)&0xFF, //低字節
 (sizeof(ConfigurationDescriptor)>>8)&0xFF, //高字節
 
 //bNumInterfaces字段。該配置包含的接口數，只有一個接口。
 0x01,
 
 //bConfiguration字段。該配置的值為1。
 0x01,
 
 //iConfigurationz字段，該配置的字符串索引。這里沒有，為0。
 0x00,
 
 //bmAttributes字段，該設備的屬性。由于我們的板子是總線供電的，
 //并且我們不想實現遠程喚醒的功能，所以該字段的值為0x80。
 0x80,
 
 //bMaxPower字段，該設備需要的最大電流量。由于我們的板子
 //需要的電流不到100mA，因此我們這里設置為100mA。由于每單位
 //電流為2mA，所以這里設置為50(0x32)。
 0x32,
 
 /*******************接口描述符*********************/
 //bLength字段。接口描述符的長度為9字節。
 0x09,
 
 //bDescriptorType字段。接口描述符的編號為0x04。
 0x04,
 
 //bInterfaceNumber字段。該接口的編號，第一個接口，編號為0。
 0x00,
 
 //bAlternateSetting字段。該接口的備用編號，為0。
 0x00,
 
 //bNumEndpoints字段。非0端點的數目。該USB鍵盤需要二個
 //中斷端點（一個輸入一個輸出），因此該值為2。
 0x02,
 
 //bInterfaceClass字段。該接口所使用的類。USB鍵盤是HID類，
 //HID類的編碼為0x03。
 0x03,
 
 //bInterfaceSubClass字段。該接口所使用的子類。在HID1.1協議中，
 //只規定了一種子類：支持BIOS引導啟動的子類。
 //USB鍵盤、鼠標屬于該子類，子類代碼為0x01。
 0x01,
 
 //bInterfaceProtocol字段。如果子類為支持引導啟動的子類，
 //則協議可選擇鼠標和鍵盤。鍵盤代碼為0x01，鼠標代碼為0x02。
 0x01,
 
 //iConfiguration字段。該接口的字符串索引值。這里沒有，為0。
 0x00,
 
 /******************HID描述符************************/
 //bLength字段。本HID描述符下只有一個下級描述符。所以長度為9字節。
 0x09,
 
 //bDescriptorType字段。HID描述符的編號為0x21。
 0x21,
 
 //bcdHID字段。本協議使用的HID1.1協議。注意低字節在先。
 0x10,
 0x01,
 
 //bCountyCode字段。設備適用的國家代碼，這里選擇為美國，代碼0x21。
 0x21,
 
 //bNumDescriptors字段。下級描述符的數目。我們只有一個報告描述符。
 0x01,
 
 //bDescritporType字段。下級描述符的類型，為報告描述符，編號為0x22。
 0x22,
 
 //bDescriptorLength字段。下級描述符的長度。下級描述符為報告描述符。
 sizeof(ReportDescriptor)&0xFF,
 (sizeof(ReportDescriptor)>>8)&0xFF,
 
 /**********************輸入端點描述符***********************/
 //bLength字段。端點描述符長度為7字節。
 0x07,
 
 //bDescriptorType字段。端點描述符編號為0x05。
 0x05,
 
 //bEndpointAddress字段。端點的地址。我們使用D12的輸入端點1。
 //D7位表示數據方向，輸入端點D7為1。所以輸入端點1的地址為0x81。
 0x81,