USB自定義HID設備實現-STM32

該文檔使用USB固件庫,在其基礎上進行了本身的定製,完成了一個USB-HID設備,首先是usb_desc.c文件,裏面存放了usb各類描述符的存在

#include "usb_desc.h"

 

//usb標準設備描述符

const u8 DinkUsbDeviceDescriptor[DINK_USB_SIZ_DEVICE_DESC] = {

 

    USB_DEVICE_DESC_SIZE,             //bLength字段。設備描述符的長度爲18(0x12)字節

    USB_DEVICE_DESCRIPTOR_TYPE,           //bDescriptorType字段。設備描述符的編號爲0x01

    WBVAL(0x0200),                       //bcdUSB字段。這裏設置版本爲USB1.1，即0x0110。

    0x00,                             //bDeviceClass字段。咱們不在設備描述符中定義設備類，

    0x00,                              //bDeviceSubClass字段。bDeviceClass字段爲0時，該字段也爲0。

    0x00,                              //bDeviceProtocol字段。bDeviceClass字段爲0時，該字段也爲0。

    0x40,                               //bMaxPacketSize0字段。端點0的最大包長度。

    WBVAL(0x7777),                       //idVender字段。廠商ID號，咱們這裏取0x8888，僅供實驗用。

    WBVAL(0x8888),                       //idProduct字段。產品ID號，因爲是第一個實驗，咱們這裏取0x0001。\。

    WBVAL(0x0100),                     // 設備的版本

    0x01,                             //iManufacturer字段。廠商字符串的索引值，爲了方便記憶和管理

    0x02,                             //iProduct字段。產品字符串的索引值。剛剛用了1，這裏就取2吧。

    0x03,                              //iSerialNumber字段。設備的序列號字符串索引值。

    0x01                                //bNumConfigurations字段。該設備所具備的配置數。

};

 

 

//USB報告描述符的定義

const u8 HID_ReportDescriptor[]=

{

0x06,0xA0,0xFF,//用法頁(FFA0h, vendor defined)

0x09, 0x01,//用法(vendor defined)

0xA1, 0x01,//集合(Application)

0x09, 0x02 ,//用法(vendor defined)

0xA1, 0x00,//集合(Physical)

0x06,0xA1,0xFF,//用法頁(vendor defined)

//輸入報告

0x09, 0x03 ,//用法(vendor defined)

0x09, 0x04,//用法(vendor defined)

0x15, 0x80,//邏輯最小值(0x80 or -128)

0x25, 0x7F,//邏輯最大值(0x7F or 127)

0x35, 0x00,//物理最小值(0)

0x45,0xFF,//物理最大值(255)

0x75, 0x08,//報告長度Report size (8位)

0x95, 0x40,//報告數值(64 fields)

0x81, 0x02,//輸入(data, variable, absolute)

//輸出報告

0x09, 0x05,//用法(vendor defined)

0x09, 0x06,//用法(vendor defined)

0x15, 0x80,//邏輯最小值(0x80 or -128)

0x25, 0x7F,//邏輯最大值(0x7F or 127)

0x35, 0x00,//物理最小值(0)

0x45,0xFF,//物理最大值(255)

0x75,0x08,//報告長度(8位)

0x95, 0x40,//報告數值(64 fields)

0x91, 0x02,//輸出(data, variable, absolute)

0xC0,//集合結束(Physical)

0xC0//集合結束(Application)

};

//經過上面的報告描述符的定義，咱們知道返回的輸入報告具備8字節。

//輸出報告也有64字節。至於這64字節的數據是幹什麼用的，就要由用戶

//本身來決定了。

///報告描述符完畢

 

 

//usb配置描述符

const u8 DinkUsbConfigDescriptor[DINK_USB_SIZ_CONFIG_DESC] = {

    /***************配置描述符***********************/

    USB_CONFIGUARTION_DESC_SIZE,       //bLength字段。配置描述符的長度爲9字節。

    USB_CONFIGURATION_DESCRIPTOR_TYPE, //bDescriptorType字段。配置描述符編號爲0x02。

    //wTotalLength字段。配置描述符集合的總長度，

    //包括配置描述符自己、接口描述符、類描述符、端點描述符等。

    WBVAL( 

    USB_CONFIGUARTION_DESC_SIZE +           //配置描述符

    USB_INTERFACE_DESC_SIZE     +        //接口1描述符

    9                           +           //hid描述符

    USB_ENDPOINT_DESC_SIZE      +           //端點描述符

    USB_ENDPOINT_DESC_SIZE                  //端點描述符

    ),

    0x01,                                   //bNumInterfaces字段。該配置包含的接口數，只有一個接口。

    0x01,                                   //bConfiguration字段。該配置的值爲1。

    0x00,                                  //iConfigurationz字段，該配置的字符串索引。這裏沒有，爲0。

    USB_CONFIG_BUS_POWERED ,                //bmAttributes字段，該設備的屬性

    USB_CONFIG_POWER_MA(500),                  //bMaxPower字段，該設備須要的最大電流量

 

    /*********************第一個接口描述符,hid設備**********************/

    USB_INTERFACE_DESC_SIZE,              //bLength字段。接口描述符的長度爲9字節。

    USB_INTERFACE_DESCRIPTOR_TYPE,           //bDescriptorType字段。接口描述符的編號爲0x04。

    0x00,                                  //bInterfaceNumber字段。該接口的編號，第一個接口，編號爲0。

    0x00,                                  //bAlternateSetting字段。該接口的備用編號，爲0。

    0x02,                                   //bNumEndpoints字段。非0端點的數目。該接口有2個批量端點

 

    USB_DEVICE_CLASS_HUMAN_INTERFACE,       //bInterfaceClass字段。該接口所使用的類。大容量存儲設備接口類的代碼爲0x08。，

   

    0x00,                                   //bInterfaceSubClass字段。該接口所使用的子類。在HID1.1協議中，

                                            //只規定了一種子類：支持BIOS引導啓動的子類。

                                            //USB鍵盤、鼠標屬於該子類，子類代碼爲0x01。

                                            //但這裏咱們是自定義的HID設備，因此不使用子類。

   

    0x00,                                   //bInterfaceProtocol字段。若是子類爲支持引導啓動的子類，

                                            //則協議可選擇鼠標和鍵盤。鍵盤代碼爲0x01，鼠標代碼爲0x02。

                                            //自定義的HID設備，也不使用協議。

 

    0x00,                                   //iConfiguration字段。該接口的字符串索引值。這裏沒有，爲0。

 

    /*********************HID報告描述符*************************/

    //bLength字段。本HID描述符下只有一個下級描述符。因此長度爲9字節。

     0x09,

     

     //bDescriptorType字段。HID描述符的編號爲0x21。

     0x21,

     

     //bcdHID字段。本協議使用的HID1.1協議。注意低字節在先。

     0x10,

     0x01,

     

     //bCountyCode字段。設備適用的國家代碼，這裏選擇爲美國，代碼0x21。

     0x21,

     

     //bNumDescriptors字段。下級描述符的數目。咱們只有一個報告描述符。

     0x01,

     

     //bDescriptorType字段。下級描述符的類型，爲報告描述符，編號爲0x22。

     0x22,

     

     //bDescriptorLength字段。下級描述符的長度。下級描述符爲報告描述符。

     sizeof(HID_ReportDescriptor)&0xFF,

     (sizeof(HID_ReportDescriptor)>>8)&0xFF,

    /*********************端點描述符**********************************/

    /* 端點描述符 */

    USB_ENDPOINT_DESC_SIZE,                //bLength字段。端點描述符長度爲7字節。

    USB_ENDPOINT_DESCRIPTOR_TYPE,            //bDescriptorType字段。端點描述符編號爲0x05。

    USB_ENDPOINT_IN(1),                     //bEndpointAddress字段。端點的地址。咱們使用D12的輸入端點1。

    USB_ENDPOINT_TYPE_INTERRUPT,              //bmAttributes字段。D1~D0爲端點傳輸類型選擇。

    WBVAL(0x0040),                           //wMaxPacketSize字段。該端點的最大包長。最大包長爲64字節。

    0x01,                                        //bInterval字段。端點查詢的時間，端點查詢的時間，此處無心義。

    /***********************端點描述符*******************************************/

    USB_ENDPOINT_DESC_SIZE,                //bLength字段。端點描述符長度爲7字節。

    USB_ENDPOINT_DESCRIPTOR_TYPE,            //bDescriptorType字段。端點描述符編號爲0x05。

    USB_ENDPOINT_OUT(1),                    //bEndpointAddress字段。端點的地址。咱們使用D12的輸入端點1。

    USB_ENDPOINT_TYPE_INTERRUPT,              //bmAttributes字段。D1~D0爲端點傳輸類型選擇。

    WBVAL(0x0040),                           //wMaxPacketSize字段。該端點的最大包長。最大包長爲64字節。

    0x01,                                        //bInterval字段。端點查詢的時間，端點查詢的時間，此處無心義。

};

 

 

 

 

 

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

const u8 DinkUsbLanguageId[DINK_USB_SIZ_STRING_LANGID]=

{

    0x04, //本描述符的長度

    0x03, //字符串描述符

    //0x0409爲美式英語的ID

    0x09,

    0x04

};

 

 

語言ID完畢//

 

//Unicode 字符串描述符

//鄧小俊的usb鼠標

const u8 DinkUsbManufacturerStringDescriptor[DINK_USB_SIZ_STRING_VENDOR]=

{

    32,         //該描述符的長度爲32字節

    0x03,       //字符串描述符的類型編碼爲0x03

    0x44, 0x00, //D

    0x49, 0x00, //I

    0x4e, 0x00, //N

    0x4b, 0x00, //K

    0x5f, 0x00, //_

    0x48, 0x00, //H

    0x49, 0x00, //I

    0x44, 0x00, //D

    0x5f, 0x00, //_

    0x44, 0x00, //D

    0x45, 0x00, //E

    0x56, 0x00, //V

    0x49, 0x00, //I

    0x43, 0x00, //C

    0x45, 0x00  //E

 

};

/廠商字符串結束/

 

 

//產品字符串描述符

const u8 DinkUsbProductStringDescriptor[DINK_USB_SIZ_STRING_PRODUCT]=

{

    32,         //該描述符的長度爲32字節

    0x03,       //字符串描述符的類型編碼爲0x03

    0x44, 0x00, //D

    0x49, 0x00, //I

    0x4e, 0x00, //N

    0x4b, 0x00, //K

    0x5f, 0x00, //_

    0x48, 0x00, //H

    0x49, 0x00, //I

    0x44, 0x00, //D

    0x5f, 0x00, //_

    0x44, 0x00, //D

    0x45, 0x00, //E

    0x56, 0x00, //V

    0x49, 0x00, //I

    0x43, 0x00, //C

    0x45, 0x00  //E

};

產品字符串結束

 

//字符串「2008-07-07」的Unicode編碼

//8位小端格式

const u8 DinkUsbSerialNumberStringDescriptor[DINK_USB_SIZ_STRING_SERIAL]={

    22,         //該描述符的長度爲22字節

    0x03,       //字符串描述符的類型編碼爲0x03

    0x32, 0x00, //2

    0x30, 0x00, //0

    0x31, 0x00, //1

    0x35, 0x00, //5

    0x2d, 0x00, //-

    0x30, 0x00, //0

    0x33, 0x00, //3

    0x2d, 0x00, //-

    0x32, 0x00, //2

    0x31, 0x00  //1

};

//產品序列號字符串結束/

 

//產品序列號

u8 DinkUsbStringSerialUniqueId[DINK_USB_SIZ_STRING_SERIAL_UNIQUE_ID] =

{

    DINK_USB_SIZ_STRING_SERIAL_UNIQUE_ID,        //描述符長度

    0x03                                                      //描述符類型編碼

/* Serial number該編碼將會

 

能夠經過修改該文件實現不一樣的設備,第二是usb_prop.c文件,定義了一系列的回調函數,在usb枚舉階段使用

#include "usb_prop.h"

 

u32 ProtocolValue;

 

//代表有多少端點,多少種配置

DEVICE Device_Table =

{

    EP_NUM,

    1

};

 

//static u8 s_Request = 0;//記錄當前請求值

 

//設備描述符

ONE_DESCRIPTOR Device_Descriptor =

{

    (u8*)DinkUsbDeviceDescriptor,

    DINK_USB_SIZ_DEVICE_DESC

};

 

//配置描述符

ONE_DESCRIPTOR Config_Descriptor =

{

    (u8*)DinkUsbConfigDescriptor,

    DINK_USB_SIZ_CONFIG_DESC

};

//報告描述符

ONE_DESCRIPTOR DinkUsb_Report_Descriptor =

{

    (u8*)HID_ReportDescriptor,

    HID_ReportDescSize

};

 

//報告描述符

ONE_DESCRIPTOR DinkUsb_Hid_Descriptor =

{

    (u8*)(DinkUsbConfigDescriptor+9),

    9

};

 

 

 

//字符串描述符

ONE_DESCRIPTOR String_Descriptor[4] =

{

    {(u8*)DinkUsbLanguageId, DINK_USB_SIZ_STRING_LANGID},

    {(u8*)DinkUsbManufacturerStringDescriptor, DINK_USB_SIZ_STRING_VENDOR},

    {(u8*)DinkUsbProductStringDescriptor, DINK_USB_SIZ_STRING_PRODUCT},

    {(u8*)DinkUsbSerialNumberStringDescriptor, DINK_USB_SIZ_STRING_SERIAL}

};

 

 

 

//USB過程處理函數數組

DEVICE_PROP Device_Property =

{

    DinkUsbInit,

    DinkUsbReset,

    DinkUsbStatus_In,

    DinkUsbStatus_Out,

    DinkUsbData_Setup,

    DinkUsbNoDataSetup,

    DinkUsbGetInterfaceSetting,

    DinkUsbGetDeviceDescriptor,

    DinkUsbGetConfigDescriptor,

    DinkUsbGetStringDescriptor,

    0,

    0x40 /*MAX PACKET SIZE*/

};

 

//usb標準數據請求結構體

//只實現了兩個,剩下的用nop方式解決了

USER_STANDARD_REQUESTS User_Standard_Requests =

{

    DinkUsbGetConfiguration,

    DinkUsbSetConfiguration,

    DinkUsbGetInterface,

    DinkUsbSetInterface,

    DinkUsbGetStatus,

    DinkUsbClearFeature,

    DinkUsbSetEndPointFeature,

    DinkUsbSetDeviceFeature,

    DinkUsbSetDeviceAddress

};

 

 

 

//設備初始化

void DinkUsbInit(void)

{

    Get_SerialNum();        //構建字符串描述符

    pInformation->Current_Configuration = 0;      //當前選擇的配置爲0

    PowerOn();          //鏈接USB

    _SetISTR(0);

    wInterrupt_Mask = IMR_MSK;

    _SetCNTR(wInterrupt_Mask);

    bDeviceState = UNCONNECTED;   //設備狀態初始化爲未鏈接狀態

    usb_debug_printf("USB Init\r\n");

}

 

//設備復位

void DinkUsbReset(void)

{

    Device_Info.Current_Configuration = 0;  //選擇當前配置爲0

    pInformation->Current_Feature = DinkUsbConfigDescriptor[7]; //獲取配置描述符中當前設備屬性

    pInformation->Current_Interface = 0;//設置當前設備接口

    SetBTABLE(BTABLE_ADDRESS);//設置緩衝區地址

   

    SetEPType(ENDP0, EP_CONTROL);//控制端點

    SetEPTxStatus(ENDP0, EP_TX_STALL);

    SetEPRxAddr(ENDP0, ENDP0_RXADDR);//設置端點緩衝區地址

    SetEPTxAddr(ENDP0, ENDP0_TXADDR);

    Clear_Status_Out(ENDP0);

    SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);//設置接收最大長度

    SetEPRxValid(ENDP0);

   

    SetEPType(ENDP1, EP_INTERRUPT);//初始化端點1爲中斷傳輸模式,用來報告一些狀態

    SetEPTxAddr(ENDP1, ENDP1_TXADDR);//設置端點地址

    SetEPRxAddr(ENDP1, ENDP1_RXADDR);//設置端點地址

    SetEPRxStatus(ENDP1, EP_RX_VALID);//使能接收

    SetEPTxStatus(ENDP1, EP_TX_NAK);  //不使能發送

    SetEPRxCount(ENDP1, 64);//設置接收最大長度

    Clear_Status_Out(ENDP1);

 

    bDeviceState = ATTACHED;//設備插入

   

    SetDeviceAddress(0);//設置當前地址爲0

    usb_debug_printf("USB Reset\r\n");

}

 

//不知道幹嗎的

void DinkUsbStatus_In(void)

{

    return;

}

//不知道幹嗎的

void DinkUsbStatus_Out(void)

{

    return;

}

 

u8 *DinkUsbGetReportDescriptor(u16 Length)

{

    usb_debug_printf("獲取報告描述符\r\n");

    return Standard_GetDescriptorData(Length, &DinkUsb_Report_Descriptor);

}

 

u8 *DinkUsbGetHIDDescriptor(u16 Length)

{

    usb_debug_printf("獲取HID述符\r\n");

    return Standard_GetDescriptorData(Length, &DinkUsb_Hid_Descriptor);

}

 

u8 *DinkUsbGetProtocolValue(u16 Length)

{

    usb_debug_printf("獲取協議\r\n");

    if (Length == 0)

    {

        pInformation->Ctrl_Info.Usb_wLength = 1;

        return NULL;

    }

    else

    {

        return (u8 *)(&ProtocolValue);

    }

}

 

RESULT DinkUsbData_Setup(u8 RequestNo)

{

    u8 *(*CopyRoutine)(u16);

 

    CopyRoutine = NULL;

    if ((RequestNo == GET_DESCRIPTOR)

    && (Type_Recipient == (STANDARD_REQUEST | INTERFACE_RECIPIENT))

    && (pInformation->USBwIndex0 == 0))

    {

        //獲取報告描述符

        if (pInformation->USBwValue1 == REPORT_DESCRIPTOR)

        {

            CopyRoutine = DinkUsbGetReportDescriptor;

        }

        //獲取HID描述符

        else if (pInformation->USBwValue1 == HID_DESCRIPTOR_TYPE)

        {

            CopyRoutine = DinkUsbGetHIDDescriptor;

        }

 

    }

 

    /*** GET_PROTOCOL ***/

    else if ((Type_Recipient == (CLASS_REQUEST | INTERFACE_RECIPIENT))

       && RequestNo == GET_PROTOCOL)

    {

        CopyRoutine = DinkUsbGetProtocolValue;//獲取協議值

    }

 

 

    if (CopyRoutine == NULL)

    {

        return USB_UNSUPPORT;

    }

 

    pInformation->Ctrl_Info.CopyData = CopyRoutine;

    pInformation->Ctrl_Info.Usb_wOffset = 0;

    (*CopyRoutine)(0);

    return USB_SUCCESS;

}

 

RESULT DinkUsbSetProtocol(void)

{

  u8 wValue0 = pInformation->USBwValue0;

  ProtocolValue = wValue0;

  return USB_SUCCESS;

}

 

RESULT DinkUsbNoDataSetup(u8 RequestNo)

{

    if ((Type_Recipient == (CLASS_REQUEST | INTERFACE_RECIPIENT))

    && (RequestNo == SET_PROTOCOL))

    {

        usb_debug_printf("設置協議\r\n");

        return DinkUsbSetProtocol();

    }

    else

    {

        return USB_UNSUPPORT;

    }

}

 

 

RESULT DinkUsbGetInterfaceSetting(u8 Interface, u8 AlternateSetting)

{

    if (AlternateSetting > 0)//配置數量

    {

        usb_debug_printf("設置配置\r\n");

        return USB_UNSUPPORT;

    }

    else if (Interface > 1)//接口數量

    {

        usb_debug_printf("設置接口\r\n");

        return USB_UNSUPPORT;

    }

    return USB_SUCCESS;

}

 

//獲取設備描述符

u8 *DinkUsbGetDeviceDescriptor(u16 Length)

{

    usb_debug_printf("獲取設備描述符\r\n");

    return Standard_GetDescriptorData(Length, &Device_Descriptor);

}

//配置描述符

u8 *DinkUsbGetConfigDescriptor(u16 Length)

{

    usb_debug_printf("獲取配置描述符\r\n");

    return Standard_GetDescriptorData(Length, &Config_Descriptor);

}

//字符串描述符

u8 *DinkUsbGetStringDescriptor(u16 Length)

{

 

    u8 wValue0 = pInformation->USBwValue0;

    usb_debug_printf("獲取字符串描述符 %d\r\n",wValue0);

    if (wValue0 > 4)

    {

        return NULL;

    }

    else

    {

        return Standard_GetDescriptorData(Length, &String_Descriptor[wValue0]); //返回字符串描述符

    }

}

 

 

 

 

 

//將設備狀態上傳到配置數據中

void DinkUsbSetConfiguration(void)

{

 

    DEVICE_INFO *pInfo = &Device_Info;

    usb_debug_printf("設置配置\r\n");

    if (pInfo->Current_Configuration != 0)

    {

        bDeviceState = CONFIGURED;

    }

}

//將地址設置上傳

void DinkUsbSetDeviceAddress (void)

{

    usb_debug_printf("設置地址\r\n");

    bDeviceState = ADDRESSED;

}

 

 

其中最核心的兩個函數分別是復位和初始化,復位的時候要將端點配置好,而且接受最好要使能,不然沒法接收數據(後期本身使能也能夠),而後就是端點的處理函數了usb_endp.c

#include "usb_endp.h"

 

//發送完成置1 發送未完成置0

u8 sendOk = 1;

//接收到數據該設置爲1,數據處理完成以後修改成0

u8 ReceiveOk = 0;

 

void EP1_IN_Callback(void)

{

    //設備向主機發送數據的回調函數

    sendOk = 1;//發送成功爲1

    SetEPTxStatus(ENDP1, EP_TX_NAK);//發送成功等待第二次設置爲valid

}

 

void EP1_OUT_Callback(void)

{

    //接收了一次數據以後等待數據處理,將接受響應設置爲NAK

    //處理完成以後再設置爲VALID

    SetEPRxStatus(ENDP1, EP_RX_NAK);//NAK接收

    ReceiveOk = 1;//有數據標誌爲1

 

}

 

要想使能這些函數,須要將端點響應函數打開

另外,單片機應當來處理或者發送數據,依靠usb_data_process.h文件完成

#include "usb_data_process.h"

 

 

//HID發送數據

//返回1發送失敗 返回0發送成功

u8 HID_Send_Data(u8* buffer,u8 length)

{

    if(sendOk == 1)

    {

        if(length == 0)

        {

            SetEPTxStatus(ENDP1, EP_TX_NAK);//不發送

        }

        else

        {

            UserToPMABufferCopy(buffer, GetEPTxAddr(ENDP1), length);

            SetEPTxCount(ENDP1, length);

            SetEPTxValid(ENDP1);//使能發送

            sendOk = 0;//設置發送未完成狀態,等待發送回調函數將數據發送到主機

        }

        return 0;

    }

    else

    {

        return 1;//上一次的數據還沒發送出去,因此此次發送失敗

    }

}

 

 

//HID接收數據處理

u8 HID_Receive_Data(u8* buffer)

{

    u16 length = 0;//獲取接收到的數據長度

    u8 i = 0;

    if(ReceiveOk == 1)//有數據

    {

        length = GetEPRxCount(ENDP1);

        if(length == 0)return 0;

        else

        {

            PMAToUserBufferCopy(buffer, GetEPRxAddr(ENDP1), length);

            SetEPRxValid(ENDP1);//使能接收

            ReceiveOk = 0;

           

            printf("hid receive : ");

            for(i = 0; i < length; i++)

            {

                printf("%c ",buffer[i]);

            }

            printf("\r\n");

           

            return length;//返回接收到的數據

        }

    }

    else

    {

        //沒有數據,直接爲0

        return 0;

    }

}

 

 

作好這裏,基本上就能實現通信了,