《極海芯得》系列內容為用戶使用極海系列產品的經驗總結，均轉載自21ic論壇極海半導體專區(qū)，全文未作任何修改，未經原文作者授權禁止轉載。
最近需要使用到 APM32F427 枚舉成Custom HID設備進行用戶自定義通信，但是官方的例程只有提供的HID枚舉為鼠標或者鍵盤類型的設備。這里記錄一下，怎么使用Geehy官方的USB中間件，實現(xiàn)自定義的USB HID設備進行用戶通信。
1. USB HID設備簡介
USB HID類是USB設備的一個標準設備類，它屬于人機交互操作的設備，用于控制計算機操作的一些方面，如USB鼠標、USB鍵盤、USB游戲操縱桿等。但HID設備類不一定要有人機接口，只要符合HID類別規(guī)范的設備都是HID設備。
USB HID設備的一個好處就是操作系統(tǒng)自帶了HID類的驅動程序，而用戶無需去開發(fā)驅動程序，只要使用API系統(tǒng)調用即可完成通信。所以經常會把MCU的USB外設枚舉為自定義的HID設備類，用于和電腦的上位機進行通信。
關于USB HID設備，這里只是簡單介紹下，大家可以查閱網上的資料，或者從下面的USB官網進行學習。
USB HID設備類官網介紹：https://www.usb.org/hid
2. 基于官網的USB中間件如何實現(xiàn)Custom HID設備
2.1 準備工作
官方 F427 芯片的SDK已經提供了很多的USB例程，我們基于官方的USB例程修改即可。
1、下載官網APM32F427 SDK：https://www.geehy.com/product/fifth/APM32F427_425_423#design
2、我們要實現(xiàn)自定義的USB HID設備，與之最接近的就是427 SDK中提供的OTGD_Custom_HID_Keyboard例程。我們復制一份該例程，基于該例程修改為USB Custom HID設備例程。
2.2 修改USB HID報告描述符
報告描述符就是描述報告（HID接口上傳輸事務中的數(shù)據(jù)）的一組數(shù)據(jù)結構。
USB的報告描述符組成，都有其特定的組成格式。關于USB HID的報告描述符的組成和格式，可參考官方文檔《Device Class Definition for human interface device (HID)》。這里不多介紹報告描述符了，直接介紹如何修改代碼即可。
把usbd_custom_hid_if.c文件定義的報告描述符數(shù)組：
把該文件定義的報告描述符直接修改為如下代碼：
/**
* @brief CUSTOM HID report descriptor
*/
uint8_t USBD_CUSTOM_HIDReportDesc[USBD_CUSTOM_HID_REPORT_DESC_SIZE] =
{
/* USER CODE BEGIN 0 */
0x06, 0xFF, 0x00, /* USAGE_PAGE (Vendor Page: 0xFF00) */
0x09, 0x01, /* USAGE (Demo Kit) */
0xa1, 0x01, /* COLLECTION (Application) */
// The Input report
0x09,0x03, // USAGE ID - Vendor defined
0x15,0x00, // LOGICAL_MINIMUM (0)
0x26,0x00, 0xFF, // LOGICAL_MAXIMUM (255)
0x75,0x08, // REPORT_SIZE (8)
0x95,64, // REPORT_COUNT :SendLength
0x81,0x02, // INPUT (Data,Var,Abs)
// The Output report
0x09,0x04, // USAGE ID - Vendor defined
0x15,0x00, // LOGICAL_MINIMUM (0)
0x26,0x00,0xFF, // LOGICAL_MAXIMUM (255)
0x75,0x08, // REPORT_SIZE (8)
0x95,64, // REPORT_COUNT:ReceiveLength
0x91,0x02, // OUTPUT (Data,Var,Abs)
/* USER CODE END 0 */
0xC0 /* END_COLLECTION */
};
該描述符主要是定義了輸入輸出Input、Ouput兩個報告。其中，Input用于MCU上傳數(shù)據(jù)，Output下傳數(shù)據(jù)。所有報告大小定義為64byte，也就是說每次最大上下傳數(shù)據(jù)量也就為64byte。
另外數(shù)組 USBD_CUSTOM_HID_REPORT_DESC_SIZE 這個宏定義需要修改為我們定義的報告描述符的大小，也就是34。在對應的頭文件修改如下：
2.3 修改接收回調函數(shù)
usbd_custom_hid_if.c文件實現(xiàn)了一個接收處理函數(shù)，當USB檢測到有數(shù)據(jù)接收時，會調用該函數(shù)進行接收數(shù)據(jù)處理。
我們需要修改該函數(shù)，當有數(shù)據(jù)接收時，使得 USB_Received_Flag 變量置1，用于上層數(shù)據(jù)處理函數(shù)的處理。修改的代碼如下：
uint8_t USB_Received_Flag = 0;
/*!
* @brief USB device CUSTOM HID interface receive handler
*
* @param buffer: Command data buffer
*
* @param length: Command data length
*
* @retval USB device operation status
*/
USBD_STA_T USBD_FS_CUSTOM_HID_ItfReceive(uint8_t *buffer, uint8_t *length)
{
USBD_STA_T usbStatus = USBD_OK;
UNUSED(length);
USB_Received_Flag = 1; // 檢測到有數(shù)據(jù)接收，標志位置1
USBD_CUSTOM_HID_RxPacket(&gUsbDeviceFS);
return usbStatus;
}
2.4 實現(xiàn)應用層用戶代碼的收發(fā)函數(shù)
1、實現(xiàn)USB Custom HID設備接收函數(shù)
我們實現(xiàn)一個USB HID的數(shù)據(jù)接收函數(shù)，當檢測到 USB_Received_Flag 標志位置1之后，就可以調用該函數(shù)進行數(shù)據(jù)接收。
uint32_t USB_GetData(uint8_t *data, uint32_t dataNum)
{
USBD_CUSTOM_HID_INFO_T* usbDevHID = (USBD_CUSTOM_HID_INFO_T*)gUsbDeviceFS.devClass[gUsbDeviceFS.classID]->classData;
if (usbDevHID == NULL)
{
return 0;
}
if (dataNum > usbDevHID->reportSize)
{
dataNum = usbDevHID->reportSize;
}
for (uint32_t i = 0; i < dataNum; i++)
{
*data++ = usbDevHID->report[i];
}
return dataNum;
}
接收到的數(shù)據(jù)會存放在USB的 gUsbDeviceFS 全局變量中，該全局變量包含了USB的所有信息。
2、實現(xiàn)USB Custom HID設備發(fā)送函數(shù)
USB HID設備發(fā)送數(shù)據(jù)，我們只需要調用F427 SDK提供的 USBD_CUSTOM_HID_TxReport 函數(shù)發(fā)送數(shù)據(jù)即可。我們對該函數(shù)封裝一層用于用戶調用。
uint32_t USB_SendData(uint8_t *data, uint32_t dataNum)
{
// USBD_CUSTOM_HID_IN_EP_SIZE 64
if (USBD_OK != USBD_CUSTOM_HID_TxReport(&gUsbDeviceFS, data, 64))
{
return 0;
}
return dataNum;
}
2.5 實現(xiàn)主函數(shù)與PC進行讀寫通信
前面已經實現(xiàn)的用戶應用層USB Custom HID設備的收發(fā)函數(shù)，我們可以在主函數(shù)調用USB HID收發(fā)函數(shù)進行讀寫通信。測試是否確實和PC端上位機實現(xiàn)了數(shù)據(jù)的收發(fā)。
主函數(shù)代碼實現(xiàn)如下：
int main(void)
{
uint8_t report[64] = {0};
DAL_DeviceConfig();
/* Infinite loop */
while (1)
{
// USB_Received_Flag 變量置1，說明有USB數(shù)據(jù)接收到。下面對接收的數(shù)據(jù)進行處理
if (USB_Received_Flag == 1)
{
USB_Received_Flag = 0;
USB_GetData(report, 64); // 獲取USB接收到的數(shù)據(jù)
// 打印測試
// for (uint32_t i = 0; i < 64; i++)
// printf("%02X ", report[i]);
USB_SendData(report, 64); // 把接收到的數(shù)據(jù)原封不懂的發(fā)送回給上位機
}
}
}
該主函數(shù)就是實現(xiàn)了簡單的USB HID數(shù)據(jù)的收發(fā)，把PC端下發(fā)給F427的USB數(shù)據(jù)，然后再返回給PC端上位機。
3. USB Custom HID設備通信的測試驗證
3.1 在電腦的設備管理器查看
在第二節(jié)修改完代碼之后，編譯下載到APM32F427芯片，運行起來后，我們可以在windows系統(tǒng)的設備管理器的人體學輸入設備，查看到我們自己實現(xiàn)的USB Custom HID的。如下：
又或者通過控制面板的設備和打印機的選項，可以查看到我們實現(xiàn)的USB HID設備，如下：
可以看到我們實現(xiàn)的APM32 Custom HID設備，說明修改的代碼已經正常運行。
3.2 通過PC端上位機工具進行數(shù)據(jù)收發(fā)測試
我們需要使用USB HID的調試工具，進行數(shù)據(jù)收發(fā)測試。關于這樣的上位機工具，網上有很多的。我這里使用的是 PortHelper 工具。這個工具大家可以網上搜一下下載。
或者下載我分享的下面這個百度網盤鏈接下載：
鏈接：https://pan.baidu.com/s/1qkZCs-dG__czkDrAvN7z-w?pwd=q6er 提取碼：q6er
1、打開PortHelper 上位機，然后選擇USB調試，然后找到 APM32 Custom HID 設備，然后打開USB。
2、PortHelper 測試與APM32F427進行USB數(shù)據(jù)收發(fā)
打開USB之后，然后我們勾選hex發(fā)送，hex顯示。然后點擊發(fā)送即可，如下圖：
然后可以PC端上位機發(fā)送的數(shù)據(jù)給APM32F427，芯片原樣返回數(shù)據(jù)給該上位機。
到這里就實現(xiàn)的我們自定義的USB Custom HID設備，該設備主要是接收PC端上位機發(fā)送過來的數(shù)據(jù)，然后APM32F427接收進行處理。在實際項目我是需要基于這個通信進行更復雜的項目開發(fā)。
注：文章作者在原帖中提供了代碼文件，有需要請至原文21ic論壇
原文地址：https://bbs.21ic.com/icview-3501049-1-1.html?_dsign=8cbdef4d
或點擊下方 閱讀原文 跳轉
↑↑↑ 點擊上方卡片關注極海 ↑↑↑
