/******************************************************************
   本程序只供學習使用，未經作者許可，不得用于其它任何用途
			
        歡迎訪問我的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.10
版本：V1.1
版權所有，盜版必究。
Copyright(C) 電腦圈圈 2008-2018
All rights reserved            
*******************************************************************/

#include "config.h"
#include "pdiusbd12.h"
#include "uart.h"
#include "usbcore.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號，由于是第一個實驗，我們這里取0x0001。
//注意小端模式，低字節應該在前。
 0x01,
 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, 0x02, // USAGE (Mouse)
 
 //這是一個主條目（bType為0）條目，開集合，后面跟的數據0x01表示
 //該集合是一個應用集合。它的性質在前面由用途頁和用途定義為
 //普通桌面用的鼠標。
 0xa1, 0x01, // COLLECTION (Application)
 
 //這是一個局部條目。說明用途為指針集合
 0x09, 0x01, //   USAGE (Pointer)
 
 //這是一個主條目，開集合，后面跟的數據0x00表示該集合是一個
 //物理集合，用途由前面的局部條目定義為指針集合。
 0xa1, 0x00, //   COLLECTION (Physical)
 
 //這是一個全局條目，選擇用途頁為按鍵（Button Page(0x09)）
 0x05, 0x09, //     USAGE_PAGE (Button)
 
 //這是一個局部條目，說明用途的最小值為1。實際上是鼠標左鍵。
 0x19, 0x01, //     USAGE_MINIMUM (Button 1)
 
 //這是一個局部條目，說明用途的最大值為3。實際上是鼠標中鍵。
 0x29, 0x03, //     USAGE_MAXIMUM (Button 3)
 
 //這是一個全局條目，說明返回的數據的邏輯值（就是我們返回的數據域的值啦）
 //最小為0。因為我們這里用Bit來表示一個數據域，因此最小為0，最大為1。
 0x15, 0x00, //     LOGICAL_MINIMUM (0)
 
 //這是一個全局條目，說明邏輯值最大為1。
 0x25, 0x01, //     LOGICAL_MAXIMUM (1)
 
 //這是一個全局條目，說明數據域的數量為三個。
 0x95, 0x03, //     REPORT_COUNT (3)
 
 //這是一個全局條目，說明每個數據域的長度為1個bit。
 0x75, 0x01, //     REPORT_SIZE (1)
 
 //這是一個主條目，說明有3個長度為1bit的數據域（數量和長度
 //由前面的兩個全局條目所定義）用來做為輸入，
 //屬性為：Data,Var,Abs。Data表示這些數據可以變動，Var表示
 //這些數據域是獨立的，每個域表示一個意思。Abs表示絕對值。
 //這樣定義的結果就是，第一個數據域bit0表示按鍵1（左鍵）是否按下，
 //第二個數據域bit1表示按鍵2（右鍵）是否按下，第三個數據域bit2表示
 //按鍵3（中鍵）是否按下。
 0x81, 0x02, //     INPUT (Data,Var,Abs)
 
 //這是一個全局條目，說明數據域數量為1個
 0x95, 0x01, //     REPORT_COUNT (1)
 
 //這是一個全局條目，說明每個數據域的長度為5bit。
 0x75, 0x05, //     REPORT_SIZE (5)
 
 //這是一個主條目，輸入用，由前面兩個全局條目可知，長度為5bit，
 //數量為1個。它的屬性為常量（即返回的數據一直是0）。
 //這個只是為了湊齊一個字節（前面用了3個bit）而填充的一些數據
 //而已，所以它是沒有實際用途的。
 0x81, 0x03, //     INPUT (Cnst,Var,Abs)
 
 //這是一個全局條目，選擇用途頁為普通桌面Generic Desktop Page(0x01)
 0x05, 0x01, //     USAGE_PAGE (Generic Desktop)
 
 //這是一個局部條目，說明用途為X軸
 0x09, 0x30, //     USAGE (X)
 
 //這是一個局部條目，說明用途為Y軸
 0x09, 0x31, //     USAGE (Y)
 
 //這是一個局部條目，說明用途為滾輪
 0x09, 0x38, //     USAGE (Wheel)
 
 //下面兩個為全局條目，說明返回的邏輯最小和最大值。
 //因為鼠標指針移動時，通常是用相對值來表示的，
 //相對值的意思就是，當指針移動時，只發送移動量。
 //往右移動時，X值為正；往下移動時，Y值為正。
 //對于滾輪，當滾輪往上滾時，值為正。
 0x15, 0x81, //     LOGICAL_MINIMUM (-127)
 0x25, 0x7f, //     LOGICAL_MAXIMUM (127)
 
 //這是一個全局條目，說明數據域的長度為8bit。
 0x75, 0x08, //     REPORT_SIZE (8)
 
 //這是一個全局條目，說明數據域的個數為3個。
 0x95, 0x03, //     REPORT_COUNT (3)
 
 //這是一個主條目。它說明這三個8bit的數據域是輸入用的，
 //屬性為：Data,Var,Rel。Data說明數據是可以變的，Var說明
 //這些數據域是獨立的，即第一個8bit表示X軸，第二個8bit表示
 //Y軸，第三個8bit表示滾輪。Rel表示這些值是相對值。
 0x81, 0x06, //     INPUT (Data,Var,Rel)
 
 //下面這兩個主條目用來關閉前面的集合用。
 //我們開了兩個集合，所以要關兩次。bSize為0，所以后面沒數據。
 0xc0,       //   END_COLLECTION
 0xc0        // END_COLLECTION
};
//通過上面的報告描述符的定義，我們知道返回的輸入報告具有4字節。
//第一字節的低3位用來表示按鍵是否按下的，高5位為常數0，無用。
//第二字節表示X軸改的變量，第三字節表示Y軸的改變量，第四字節表示
//滾輪的改變量。我們在中斷端點1中應該要按照上面的格式返回實際的
//鼠標數據。
///////////////////////////報告描述符完畢////////////////////////////

//USB配置描述符集合的定義
//配置描述符總長度為9+9+9+7字節
code uint8 ConfigurationDescriptor[9+9+9+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鼠標只需要一個
 //中斷輸入端點，因此該值為1。
 0x01,
 
 //bInterfaceClass字段。該接口所使用的類。USB鼠標是HID類，
 //HID類的編碼為0x03。
 0x03,
 
 //bInterfaceSubClass字段。該接口所使用的子類。在HID1.1協議中，
 //只規定了一種子類：支持BIOS引導啟動的子類。
 //USB鍵盤、鼠標屬于該子類，子類代碼為0x01。
 0x01,
 
 //bInterfaceProtocol字段。如果子類為支持引導啟動的子類，
 //則協議可選擇鼠標和鍵盤。鍵盤代碼為0x01，鼠標代碼為0x02。
 0x02,
 
 //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,
 
 //bmAttributes字段。D1~D0為端點傳輸類型選擇。
 //該端點為中斷端點。中斷端點的編號為3。其它位保留為0。
 0x03,
 
 //wMaxPacketSize字段。該端點的最大包長。端點1的最大包長為16字節。
 //注意低字節在先。
 0x10,
 0x00,
 
 //bInterval字段。端點查詢的時間，我們設置為10個幀時間，即10ms。
 0x0A
};
////////////////////////配置描述符集合完畢//////////////////////////

/************************語言ID的定義********************/