/******************************************************************
   本程序只供學(xué)習(xí)使用，未經(jīng)作者許可，不得用于其它任何用途
			
        歡迎訪(fǎng)問(wèn)我的USB專(zhuān)區(qū)：http://group.ednchina.com/93/
        歡迎訪(fǎng)問(wèn)我的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
版權(quán)所有，盜版必究。
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];  //讀端點(diǎn)0用的緩沖區(qū)

//USB設(shè)備請(qǐng)求的各字段
uint8  bmRequestType;
uint8  bRequest;
uint16 wValue;
uint16 wIndex;
uint16 wLength;
//當(dāng)前發(fā)送數(shù)據(jù)的位置
uint8 * pSendData;
//需要發(fā)送數(shù)據(jù)的長(zhǎng)度
uint16 SendLength;
//是否需要發(fā)送0數(shù)據(jù)包的標(biāo)志。在USB控制傳輸?shù)臄?shù)據(jù)過(guò)程中，
//當(dāng)返回的數(shù)據(jù)包字節(jié)數(shù)少于最大包長(zhǎng)時(shí)，會(huì)認(rèn)為數(shù)據(jù)過(guò)程結(jié)束。
//當(dāng)請(qǐng)求的字節(jié)數(shù)比實(shí)際需要返回的字節(jié)數(shù)長(zhǎng)，而實(shí)際返回的字節(jié)
//數(shù)又剛好是端點(diǎn)0大小的整數(shù)倍時(shí)，就需要返回一個(gè)0長(zhǎng)度的數(shù)據(jù)包
//來(lái)結(jié)束數(shù)據(jù)過(guò)程。因此這里增加一個(gè)標(biāo)志，供程序決定是否需要返回
//一個(gè)0長(zhǎng)度的數(shù)據(jù)包。
uint8 NeedZeroPacket;

//當(dāng)前的配置值。只有在設(shè)置非0配置后
uint8 ConfigValue;

//端點(diǎn)1緩沖是否忙的標(biāo)志。當(dāng)緩沖區(qū)中有數(shù)據(jù)時(shí)，該標(biāo)志為真。
//當(dāng)緩沖區(qū)中空閑時(shí)，該標(biāo)志為假。
uint8 Ep1InIsBusy;

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

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

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

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

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

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

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