基于STM32CubeMX生成HID雙向通訊工程的說明

　　客戶在做USB通訊的時(shí)候，基本的需求就是發(fā)送某些數(shù)據(jù)到USB host端，同時(shí)接收一些數(shù)據(jù)從USB Host端，那么如何快速的建立一個(gè)工程并驗(yàn)證數(shù)據(jù)是否正確呢?下邊我們就結(jié)合STM32F072的評(píng)估板(其他的STM32xx系列的實(shí)現(xiàn)方式都是類似的)來快速實(shí)現(xiàn)一個(gè)簡單的數(shù)據(jù)收發(fā)實(shí)驗(yàn)。

　　下面是具體操作和一些基本的解說。

　　USBHost軟件的準(zhǔn)備

　　PC端軟件使用ST免費(fèi)提供的Usb Hid Demonstrator。這個(gè)軟件可以在ST官網(wǎng)上免費(fèi)下載到。連接地址：STSW-STM32084，此軟件調(diào)用的是windows標(biāo)準(zhǔn)的HID類驅(qū)動(dòng)，所以無需安裝任何驅(qū)動(dòng)程序及可運(yùn)行。

　　下載安裝完這個(gè)軟件之后，我們就可以開始開發(fā)STM32的USB從機(jī)程序了。

　　首先，打開STM32CubeMX">STM32CubeMX，新建工程，選擇STM32F072B-DISCOVERY開發(fā)板。

　　其次，在Pinout選項(xiàng)中，開打USB的device功能。

　　并在Middleware中選擇開啟class for IP中的 custom Human Interface Device(HID)

　　點(diǎn)擊“保存”后直接生成工程。我們這里以生成IAR工程為例，項(xiàng)目名叫做HID。

　　這樣我們的工程就基本成功了，但是還缺少最最關(guān)鍵的一步，就是USB主機(jī)和從機(jī)的通訊“協(xié)議”，這個(gè)協(xié)議在那里實(shí)現(xiàn)呢?因?yàn)槲覀僅ost端軟件已經(jīng)是Usb Hid Demonstrator，那么這邊的協(xié)議就已經(jīng)固定了(其實(shí)在實(shí)際的開發(fā)中大多是主機(jī)端和從機(jī)相互溝通后，軟件自行修改的)，從機(jī)只需要對(duì)應(yīng)這套協(xié)議即可。

　　將如下代碼復(fù)制，替換掉usbd_custom_hid_if.c文件中的同名數(shù)組。

　　__ALIGN_BEGIN static uint8_tCUSTOM_HID_ReportDesc_FS [USBD_CUSTOM_HID_REPORT_DESC_SIZE] __ALIGN_END =

　　{

　　0x06, 0xFF, 0x00, /* USAGE_PAGE(Vendor Page: 0xFF00) */

　　0x09, 0x01, /* USAGE (Demo Kit) */

　　0xa1, 0x01, /* COLLECTION(Application) */

　　/* 6 */

　　/* LED1 */

　　0x85, LED1_REPORT_ID, /* REPORT_ID(1) */

　　0x09, 0x01, /* USAGE (LED 1) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x08, /* REPORT_SIZE (8) */

　　0x95, LED1_REPORT_COUNT, /*REPORT_COUNT (1) */

　　0xB1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x85, LED1_REPORT_ID, /* REPORT_ID(1) */

　　0x09, 0x01, /* USAGE (LED 1) */

　　0x91, 0x82, /* OUTPUT(Data,Var,Abs,Vol) */

　　/* 26 */

　　/* LED2 */

　　0x85, LED2_REPORT_ID, /* REPORT_ID 2*/

　　0x09, 0x02, /* USAGE (LED 2) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x08, /* REPORT_SIZE (8) */

　　0x95, LED2_REPORT_COUNT, /*REPORT_COUNT (1) */

　　0xB1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x85, LED2_REPORT_ID, /* REPORT_ID(2) */

　　0x09, 0x02, /* USAGE (LED 2) */

　　0x91, 0x82, /* OUTPUT(Data,Var,Abs,Vol) */

　　/* 46 */

　　/* LED3 */

　　0x85, LED3_REPORT_ID, /* REPORT_ID(3) */

　　0x09, 0x03, /* USAGE (LED 3) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x08, /* REPORT_SIZE (8) */

　　0x95, LED3_REPORT_COUNT, /*REPORT_COUNT (1) */

　　0xB1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x85, LED3_REPORT_ID, /* REPORT_ID(3) */

　　0x09, 0x03, /* USAGE (LED 3) */

　　0x91, 0x82, /* OUTPUT (Data,Var,Abs,Vol) */

　　/* 66 */

　　/* LED4 */

　　0x85, LED4_REPORT_ID, /* REPORT_ID4) */

　　0x09, 0x04, /* USAGE (LED 4) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x08, /* REPORT_SIZE (8) */

　　0x95, LED4_REPORT_COUNT, /*REPORT_COUNT (1) */

　　0xB1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x85, LED4_REPORT_ID, /* REPORT_ID(4) */

　　0x09, 0x04, /* USAGE (LED 4) */

　　0x91, 0x82, /* OUTPUT(Data,Var,Abs,Vol) */

　　/* 86 */

　　/* key Push Button */

　　0x85, KEY_REPORT_ID, /* REPORT_ID(5) */

　　0x09, 0x05, /* USAGE (Push Button)*/

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x01, /* REPORT_SIZE (1) */

　　0x81, 0x82, /* INPUT(Data,Var,Abs,Vol) */

　　0x09, 0x05, /* USAGE (Push Button)*/

　　0x75, 0x01, /* REPORT_SIZE (1) */

　　0xb1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x75, 0x07, /* REPORT_SIZE (7) */

　　0x81, 0x83, /* INPUT(Cnst,Var,Abs,Vol) */

　　0x85, KEY_REPORT_ID, /* REPORT_ID(2) */

　　0x75, 0x07, /* REPORT_SIZE (7) */

　　0xb1, 0x83, /* FEATURE (Cnst,Var,Abs,Vol)*/

　　/* 114 */

　　/* Tamper Push Button */

　　0x85, TAMPER_REPORT_ID,/* REPORT_ID(6) */

　　0x09, 0x06, /* USAGE (Tamper PushButton) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x25, 0x01, /* LOGICAL_MAXIMUM (1)*/

　　0x75, 0x01, /* REPORT_SIZE (1) */

　　0x81, 0x82, /* INPUT(Data,Var,Abs,Vol) */

　　0x09, 0x06, /* USAGE (Tamper PushButton) */

　　0x75, 0x01, /* REPORT_SIZE (1) */

　　0xb1, 0x82, /* FEATURE(Data,Var,Abs,Vol) */

　　0x75, 0x07, /* REPORT_SIZE (7) */

　　0x81, 0x83, /* INPUT (Cnst,Var,Abs,Vol)*/

　　0x85, TAMPER_REPORT_ID,/* REPORT_ID(6) */

　　0x75, 0x07, /* REPORT_SIZE (7) */

　　0xb1, 0x83, /* FEATURE(Cnst,Var,Abs,Vol) */

　　/* 142 */

　　/* ADC IN */

　　0x85, ADC_REPORT_ID, /* REPORT_ID */

　　0x09, 0x07, /* USAGE (ADC IN) */

　　0x15, 0x00, /* LOGICAL_MINIMUM (0)*/

　　0x26, 0xff, 0x00, /* LOGICAL_MAXIMUM(255) */

　　0x75, 0x08, /* REPORT_SIZE (8) */

　　0x81, 0x82, /* INPUT(Data,Var,Abs,Vol) */

　　0x85, ADC_REPORT_ID, /* REPORT_ID(7) */

　　0x09, 0x07, /* USAGE (ADC in) */

　　0xb1, 0x82, /* FEATURE (Data,Var,Abs,Vol)*/

　　/* 161 */

　　0xc0 /* END_COLLECTION */

　　};

　　注意：這里一定要覆蓋“同名”數(shù)組，千萬不要覆蓋錯(cuò)了。

　　之后將如下代碼復(fù)制到usbd_custom_hid_if_if.h中。

　　#define LED1_REPORT_ID 0x01

　　#define LED1_REPORT_COUNT 0x01

　　#define LED2_REPORT_ID 0x02

　　#define LED2_REPORT_COUNT 0x01

　　#define LED3_REPORT_ID 0x03

　　#define LED3_REPORT_COUNT 0x01

　　#define LED4_REPORT_ID 0x04

　　#define LED4_REPORT_COUNT 0x01

　　#define KEY_REPORT_ID 0x05

　　#define TAMPER_REPORT_ID 0x06

　　#define ADC_REPORT_ID 0x07

　　最后在usbd_conf.h文件中將USBD_CUSTOM_HID_REPORT_DESC_SIZE的定義值修改

　　為163(默認(rèn)值是2)

　　#defineUSBD_CUSTOM_HID_REPORT_DESC_SIZE 163 //2

　　為什么這樣修改呢? 簡單說一下其中關(guān)鍵值的含義。

　　這個(gè)HID 的報(bào)文描述符其實(shí)定義了8個(gè)部分(條目)的功能定義，分為LED1，LED2，LED3，

　　LED4，按鍵輸入，篡改按鍵輸入和ADC輸入。每部分的基本格式都是固定的。以LED1為例(其他條目可自行對(duì)照文檔解析)：

　　0x85, LED1_REPORT_ID， 含義是這個(gè)功能的ID號(hào)是LED1_REPORT_ID(宏定義為0x01)

　　這個(gè)ID號(hào)是每次報(bào)文發(fā)送的時(shí)候最先被發(fā)送出去的(USB都是LSB)字節(jié)，之后跟著的才是我們實(shí)際有效的數(shù)據(jù)/指令，到底是數(shù)據(jù)還是指令，就看你的應(yīng)用程序如何去解析這個(gè)數(shù)據(jù)了。

　　0x09, 0x01, 這個(gè)功能序號(hào)為1，后邊的序號(hào)依次遞加。

　　0x15, 0x00, 這個(gè)是規(guī)定邏輯最小值為0 。

　　0x25, 0x01, 這個(gè)是規(guī)定邏輯最大值為1 。

　　上邊的這兩條語句規(guī)定了跟在報(bào)文ID后邊的數(shù)據(jù)范圍，最大值是1，最小值是0.(因?yàn)槲覀兊腖ED也就只有滅和亮兩種狀態(tài))

　　0x75, 0x08, 這個(gè)是報(bào)文的大小為8，只要?jiǎng)e寫錯(cuò)就行了。

　　0x95, LED1_REPORT_COUNT， 這個(gè)是說下邊有LED1_REPORT_COUNT (宏定義為1)個(gè)項(xiàng)目會(huì)被添加，即這個(gè)功能的數(shù)量是1個(gè) 。

　　0xB1, 0x82, 這個(gè)是規(guī)定能夠發(fā)送給從機(jī)設(shè)備的數(shù)據(jù)信息。

　　0x91, 0x82, 這個(gè)規(guī)定了該功能的數(shù)據(jù)方向是輸出(傳輸方向以主機(jī)為參照)。

　　總結(jié)一下，通過這個(gè)報(bào)文描述符，我們就告訴了主機(jī)，在HID中有一個(gè)功能ID為1的功能，其方向是從主機(jī)到從機(jī)，每次發(fā)送1個(gè)有效數(shù)據(jù)(前邊的ID是都要含有的)，這個(gè)數(shù)據(jù)可以是0或者是1.

　　關(guān)于HID 報(bào)文描述符的詳細(xì)信息，您可以在下邊的網(wǎng)址下載一篇叫做《Device Class Definitionfor HID》的文檔來參考。http://www.usb.org/developers/hidpage

　　這樣基本的程序框架就已經(jīng)成功了。此時(shí)我們可以先編譯一下，看看是否有任何遺漏的或者筆誤。如果編譯是正確的，那么我們就可以先下載到硬件開發(fā)板上，連接到PC端，看看是否可以枚舉出設(shè)備。如果您前邊的修改都是正確的，那么在PC的設(shè)備管理器中會(huì)看到如下圖所示的內(nèi)容。

　　注意：開發(fā)板上有兩個(gè)一模一樣的Mini USB接口，一個(gè)是USB USER，另 一個(gè)是USB ST-link，下載代碼的時(shí)候用USB ST-Link，連接電腦運(yùn)行程序的時(shí)候要用USB USER。

　　此時(shí)我們的USB枚舉就完成了，這個(gè)是USB通訊的關(guān)鍵步驟，之后的應(yīng)用通訊內(nèi)容都是通過這個(gè)枚舉工程來進(jìn)行“規(guī)劃”的。

　　數(shù)據(jù)發(fā)送

　　就類似串口通訊，我們首先做一個(gè)數(shù)據(jù)的發(fā)送工作。

　　在Main.c文件中，我們?cè)趙hile(1)的主循環(huán)中增加我們的發(fā)送函數(shù)，主要就是調(diào)用發(fā)送報(bào)文的

　　API：USBD_CUSTOM_HID_SendReport()

　　/* USER CODE BEGIN 2 */

　　uint8_t i=0;

　　sendbuffer[0]=0x07; //這個(gè)是report ID，每次發(fā)送報(bào)文都需要以這個(gè)為開始，這樣主機(jī)才能正確//解析后邊的數(shù)據(jù)含義

　　sendbuffer[1]=0x01; //這個(gè)是實(shí)際發(fā)送的數(shù)據(jù)，可以自由定義，只要不超過報(bào)文描述符的限制

　　/* USER CODE END 2 */

　　/* Infinite loop */

　　/* USER CODE BEGIN WHILE */

　　while (1)

　　{

　　HAL_Delay(100); //延遲100ms

　　sendbuffer[1]++; //每次發(fā)送都將變量自加1

　　USBD_CUSTOM_HID_SendReport(&hUsbDeviceFS,sendbuffer,2);//發(fā)送報(bào)文

　　/* USER CODE END WHILE */

　　/* USER CODE BEGIN 3 */

　　}

　　/* USER CODE END 3 */

　　編譯后下載到MCU內(nèi)，連接上位機(jī)軟件即可看到如下所示的進(jìn)度條在不斷的增長。

　　這個(gè)就是我們上傳到的數(shù)據(jù)在上位機(jī)的圖形顯示，你也可以看Input/outputtransfer里的數(shù)據(jù)變化。

　　這樣看起來是不是更像是串口調(diào)試助手了?嘿嘿本來機(jī)制就差不多的。

　　數(shù)據(jù)接收

　　MCU的USB數(shù)據(jù)是如何接收的呢?是不是調(diào)用一個(gè)類似于串口接收的API呢?

　　不是的!USB的數(shù)據(jù)接收都是在中斷中完成的，在新建的工程中，我們?cè)诤瘮?shù)CUSTOM_HID_OutEvent_FS內(nèi)增加如下代碼。

　　static int8_t CUSTOM_HID_OutEvent_FS(uint8_t event_idx, uint8_t state)

　　{

　　/* USER CODE BEGIN 6 */switch(event_idx)

　　{

　　case 1: /* LED3 */

　　(state == 1) ?HAL_GPIO_WritePin(LD3_GPIO_Port,LD3_Pin,GPIO_PIN_SET) :

　　HAL_GPIO_WritePin(LD3_GPIO_Port,LD3_Pin,GPIO_PIN_RESET);

　　break;

　　case 2: /* LED4 */

　　(state == 1) ?HAL_GPIO_WritePin(LD4_GPIO_Port,LD4_Pin,GPIO_PIN_SET) :

　　HAL_GPIO_WritePin(LD4_GPIO_Port,LD4_Pin,GPIO_PIN_RESET);

　　break;

　　case 3: /* LED5 */

　　(state == 1) ?HAL_GPIO_WritePin(LD5_GPIO_Port,LD5_Pin,GPIO_PIN_SET) :

　　HAL_GPIO_WritePin(LD5_GPIO_Port,LD5_Pin,GPIO_PIN_RESET);

　　break;

　　case 4: /* LED6 */

　　(state == 1) ?HAL_GPIO_WritePin(LD6_GPIO_Port,LD6_Pin,GPIO_PIN_SET) :

　　HAL_GPIO_WritePin(LD6_GPIO_Port,LD6_Pin,GPIO_PIN_RESET);

　　break;

　　default:

　　break;

　　}

　　return (0);

　　/* USER CODE END 6 */

　　}

　　編譯之后下載到MCU內(nèi)，通過USB USER連接到PC端，打開Usb HidDemonstrator，我們可以通過勾選右下角的圖形界面來實(shí)現(xiàn)控制開發(fā)板上的LED電量或者關(guān)閉。

　　當(dāng)然，這個(gè)是通過圖像化的界面來進(jìn)行控制，你也可以通過Input/outputtransfer中的寫入對(duì)話框來完成這個(gè)操作。注意，寫入的第一個(gè)字節(jié)是ID，表示你想控制的是哪個(gè)LED;第二個(gè)字節(jié)是0或者是1，表示你想讓這個(gè)LDE的狀態(tài)變成滅還是亮。

　　總結(jié)：

　　本范例程序是為了快速實(shí)現(xiàn)USB 從機(jī)設(shè)備與主句設(shè)備雙向通訊目的，其初始化代碼是用STM32CubeMX來生成的，大大降低了工程師開發(fā)USB設(shè)備的難度(尤其是是入門階段的難度)。從這個(gè)工程的基礎(chǔ)上，工程師可以比較方便的建立好框架工程并，對(duì)其中的代碼進(jìn)行研究，進(jìn)而移植或增加自己的應(yīng)用代碼。