13.1實驗內容

通過本實驗主要學習以下內容：

• USB協議基本原理
• GD32H7xx USBHS的使用
• 虛擬鍵盤的協議原理及使用

13.2實驗原理

13.2.1USB通信基礎知識

USB的全稱是Universal Serial Bus,通用串行總線。它的出現主要是為了簡化個人計算機與外圍設備的連接，增加易用性。USB支持熱插拔，并且是即插即用的，另外，它還具有很強的可擴展性，傳輸速度也很快，這些特性使支持USB接口的電子設備更易用、更大眾化。GD32H7系列MCU集成了USB2.0高速OTG模塊。首先為大家介紹USB通信的一些基礎知識，包括USB協議、枚舉流程等，建議讀者可以多多閱讀USB協議，以更深入了解USB，USB官網鏈接如下，可參考：https://www.usb.org/

13.2.1.1USB金字塔型拓撲結構

塔頂為USB主控制器和根集線器(Root Hub)，下面接USB集線器(Hub)，集線器將一個USB口擴展為多個USB口，USB2.0規定集線器的層數最多為6層，理論上一個USB主控制器最多可接127個設備，因為協議規定USB設備具有一個7 bit的地址(取值范圍為0~127，而地址0是保留給未初始化的設備使用的)。

13.2.1.2NRZI編碼

USB采用差分信號傳輸，使用的是如上圖所示的NRZI編碼方式：數據為0時，電平翻轉；數據為1時，電平不翻轉。如果出現6個連續的數據1，則插入一個數據0，強制電平翻轉，以便時鐘同步。上面的一條線表示的是原始數據序列，下面的一條線表示的是經過NRZI編碼后的數據序列。

13.2.1.3USB數據協議

USB數據是由二進制數據串組成，首先由數據串構成包(packet)，包再構成事務(transaction)，事務最終構成傳輸(transfer)。

USB傳輸的最小單位為包，一個包被分成不同的域，根據不同類型的包，所包含的域是不一樣的，但是不同的包有個共同的特點，就是以包起始(SOP)開始，之后是同步域(0x00000001)，然后是包內容，最后以包結束符(EOP)結束這個包。PID為標識域，由四位標識符加4位標識符反碼構成，表明包的類型和格式。根據PID的不同，USB協議中規定的包類型有令牌包、數據包、握手包和特殊包等。

USB事務通常有兩個或三個包組成：令牌包、數據包和握手包，令牌包用來啟動一個事務，總是由主機發送；數據包用來傳輸數據；握手包由數據接收者進行發送，表明數據的接收情況。批量、同步和中斷傳輸每次傳輸都是一個事務，控制傳輸包括三個階段：建立過程、數據過程和狀態過程。

針對不同的數據傳輸場景，USB分為四種數據傳輸模式，這四種傳輸模式分別由不同的包(packet)組成，并且有不同的數據處理策略。每種數據傳輸模式的流程示意圖以及應用場景如下：

• 控制傳輸一般用于命令和狀態的傳輸，分為控制讀、控制寫和無數據控制傳輸。在設備枚舉的過程中，采用控制傳輸方式進行數據傳輸。

• 批量傳輸分為批量讀和批量寫，用于數據量大、對實時性要求不高的場合，如U盤。

• 中斷傳輸用于數據量小的場合，保證查詢頻率，如鼠標、鍵盤。

• 同步傳輸用于數據量大、同時對實時性要求較高的場合，如音視頻。不保證數據完整性，沒有ACK/NAK應答包，不進行數據重傳。

13.2.1.4USB描述符

• 一個USB設備通常有一個或多個配置，但在同一時刻只能有一個配置；
• 一個配置通常有一個或多個接口；
• 一個接口通常有一個或多個端點；

在USB通信中，USB設備需要配置多個USB描述符用以枚舉階段將描述符返回給主機，用以主機的枚舉以及識別。USB描述符包括設備描述符、配置描述符、接口描述符、端點描述符以及字符串描述符等。在GD32 USBD固件庫中，針對各種描述符都按照USB協議定義了相關結構體，具體說明如下。

• 設備描述符

每個設備必須有一個設備描述符，設備描述符提供了關于設備的配置、設備所歸屬的類、設備所遵循的協議代碼、VID、PID等信息，其相關結構體定義如下。

C typedef struct _usb_desc_dev { usb_desc_header header; /*!< descriptor header, including type and size */ uint16_t bcdUSB; /*!< BCD of the supported USB specification */ uint8_t bDeviceClass; /*!< USB device class */ uint8_t bDeviceSubClass; /*!< USB device subclass */ uint8_t bDeviceProtocol; /*!< USB device protocol */ uint8_t bMaxPacketSize0; /*!< size of the control (address 0) endpoint's bank in bytes */ uint16_t idVendor; /*!< vendor ID for the USB product */ uint16_t idProduct; /*!< unique product ID for the USB product */ uint16_t bcdDevice; /*!< product release (version) number */ uint8_t iManufacturer; /*!< string index for the manufacturer's name */ uint8_t iProduct; /*!< string index for the product name/details */ uint8_t iSerialNumber; /*!< string index for the product's globally unique hexadecimal serial number */ uint8_t bNumberConfigurations; /*!< total number of configurations supported by the device */ } usb_desc_dev;

• 配置描述符

每個USB設備都至少具有一個配置描述符，在設備描述符中規定了該設備有多少種配置，每種配置都有一個描述符，其相關結構體定義如下。

C typedef struct _usb_desc_config { usb_desc_header header; /*!< descriptor header, including type and size */ uint16_t wTotalLength; /*!< size of the configuration descriptor header,and all sub descriptors inside the configuration */ uint8_t bNumInterfaces; /*!< total number of interfaces in the configuration */ uint8_t bConfigurationValue; /*!< configuration index of the current configuration */ uint8_t iConfiguration; /*!< index of a string descriptor describing the configuration */ uint8_t bmAttributes; /*!< configuration attributes */ uint8_t bMaxPower; /*!< maximum power consumption of the device while in the current configuration */ } usb_desc_config;

• 接口描述符

接口描述符用以描述接口信息，接口描述符不能單獨返回，必須附著在配置描述符后一并返回，其相關結構體定義如下。

C typedef struct _usb_desc_itf { usb_desc_header header; /*!< descriptor header, including type and size */ uint8_t bInterfaceNumber; /*!< index of the interface in the current configuration */ uint8_t bAlternateSetting; /*!< alternate setting for the interface number */ uint8_t bNumEndpoints; /*!< total number of endpoints in the interface */ uint8_t bInterfaceClass; /*!< interface class ID */ uint8_t bInterfaceSubClass; /*!< interface subclass ID */ uint8_t bInterfaceProtocol; /*!< interface protocol ID */ uint8_t iInterface; /*!< index of the string descriptor describing the interface */ } usb_desc_itf;

• 端點描述符

端點描述符用以描述端點信息，端點描述符不能單獨返回，必須附著在配置描述符后一并返回，其相關結構體定義如下。

C typedef struct _usb_desc_ep { usb_desc_header header; /*!< descriptor header, including type and size. */ uint8_t bEndpointAddress; /*!< logical address of the endpoint */ uint8_t bmAttributes; /*!< endpoint attributes */ uint16_t wMaxPacketSize; /*!< size of the endpoint bank, in bytes */ uint8_t bInterval; /*!< polling interval in milliseconds for the endpoint if it is an INTERRUPT or ISOCHRONOUS type */ } usb_desc_ep;

• 字符串描述符

字符串描述符可含有指向描述制造商、產品、序列號、配置和接口的字符串的索引。類和制造商專屬描述符可含有指向額外字符串描述符的索引。對字符串描述符的支持是可選的，有些類可能會需要它們。

C typedef struct _usb_desc_str { usb_desc_header header; /*!< descriptor header, including type and size. */ uint16_t unicode_string[64]; /*!< unicode string data */ } usb_desc_str;

13.2.1.5USB枚舉過程

USB枚舉實際上是host檢測到device插入后，通過發送各種標準請求，請device返回各種USB描述符的過程。USB枚舉的示意圖如下：

13.2.2GD32 USBHS模塊簡介

GD32H7系列MCU提供了最多兩個USB2.0高速USBHS接口模塊，USBHS包含了一個內部的USB PHY，可以配置成全速或高速，并且不再需要外部PHY芯片。USBHS可以支持USB 2.0協議所定義的所有四種傳輸方式（控制傳輸、批量傳輸、中斷傳輸和同步傳輸）。

USBHS主要特性如下：

n支持USB 2.0高速（480Mb/s）/全速（12Mb/s）/低速（1.5Mb/s）主機模式；

n支持USB 2.0高速（480Mb/s）/全速（12Mb/s）設備模式；

n支持遵循HNP（主機協商協議）和SRP（會話請求協議）的OTG協議；

n支持所有的4種傳輸方式：控制傳輸、批量傳輸、中斷傳輸和同步傳輸；

n支持高帶寬中斷和同步傳輸；

n在主機模式下，包含USB事務調度器，用于有效地處理USB事務請求；

n包含一個4KB的FIFO RAM；

n在主機模式下，支持16個通道；

n在主機模式下，包含2個發送FIFO（周期性發送FIFO和非周期性發送FIFO）和1個接收

FIFO（由所有的通道共享）；

n在設備模式下，包含8個發送FIFO（每個IN端點一個發送FIFO）和1個接收FIFO（由所有

的OUT端點共享）；

n在主機模式下，若在高速模式下操作，支持PING協議；

n在設備模式下，支持8個OUT端點和8個IN端點；

n在設備模式下，支持遠程喚醒功能；

n包含一個支持USB OTG協議的USB PHY；

n包含一個內部DMA調度器和引擎，每個應用請求都可在USBHS和系統之間執行數據拷貝；

n在主機模式下，SOF的時間間隔可動態調節；

n可將SOF脈沖輸出到PAD；

n可檢測ID引腳電平和VBUS電壓；

n在主機模式或者OTG A設備模式下，需要外部部件為連接的USB設備提供電源；

n支持1.2版電池充電規范中描述的電池充電檢測（BCD）；

n支持2.0版USB OTG補充協議中描述的附加檢測協議（ADP）；

n支持USB 2.0鏈路層電源管理附錄和USB2.0工程變更通知單勘誤表中描述的鏈路電源管理（LPM）。

USBD模塊框圖如下所示，該系列有兩個USB HS模塊（USB_HS0和USB_HS1），均支持ULPI接口，允許外部HS收發器高速傳輸USB的數據。

GD32H7 USBHS使用注意事項可通過以下文檔學習：

https://www.gd32mcu.com/data/documents/applicationNote/AN117_GD32H7xx_USBHSshiyongzhuyishixiang_Rev1.0.pdf

13.2.3USBFS固件庫說明

USBFS 固件庫使用指南可以參考官網相關文檔，下載地址如下：https://www.gd32mcu.com/data/documents/userManual/AN050_GD32_USBFS_USBHS_Firmware_Library_User_Guide_Rev1.0_CN.pdf

13.3硬件設計

GD32H757海棠派開發板的USB通信接口選擇的是目前較為通用的Type C接口，讀者手中的用于手機充電的Type C通信線即可使用。

13.4代碼解析

本例程主要實現通過按鍵向PC發送鍵值的現象，實現模擬鍵盤的效果。

本例程主函數如下所示。

C
int main(void)
{
driver_init(); /* 延時和公共驅動部分初始化 */

bsp_uart_init(&BOARD_UART); /* 打印串口初始化 */

bsp_led_group_init(); /* 初始化LED組 */

#ifdef USE_ULPI_PHY
usb_gpio_config();
#endif /* USE_ULPI_PHY */

usb_rcu_config();

usb_timer_init();

hid_itfop_register (&hid_keyboard, &fop_handler);

#ifdef USE_USBHS0

#ifdef USE_USB_FS
usb_para_init (&hid_keyboard, USBHS0, USB_SPEED_FULL);
#endif

#ifdef USE_USB_HS
usb_para_init (&hid_keyboard, USBHS0, USB_SPEED_HIGH);
#endif

#endif /* USE_USBHS0 */

#ifdef USE_USBHS1

#ifdef USE_USB_FS
usb_para_init (&hid_keyboard, USBHS1, USB_SPEED_FULL);
#endif

#ifdef USE_USB_HS
usb_para_init (&hid_keyboard, USBHS1, USB_SPEED_HIGH);
#endif

#endif /* USE_USBHS1 */

usbd_init (&hid_keyboard, &hid_desc, &usbd_hid_cb);

#ifdef USE_USB_HS
#ifndef USE_ULPI_PHY
#ifdef USE_USBHS0
pllusb_rcu_config(USBHS0);
#elif defined USE_USBHS1
pllusb_rcu_config(USBHS1);
#else
#endif
#endif /* !USE_ULPI_PHY */
#endif /* USE_USB_HS */

usb_intr_config();

/* check if USB device is enumerated successfully */
while (USBD_CONFIGURED != hid_keyboard.dev.cur_status) {
}

while (1) {
fop_handler.hid_itf_data_process(&hid_keyboard);
}
}

C
void usb_rcu_config(void)
{
pmu_usb_regulator_enable();
pmu_usb_voltage_detector_enable();
while (pmu_flag_get(PMU_FLAG_USB33RF) != SET) {
}

#ifdef USE_USB_FS

#ifndef USE_IRC48M

#ifdef USE_USBHS0
rcu_usb48m_clock_config(IDX_USBHS0, RCU_USB48MSRC_PLL0R);
#endif /* USE_USBHS0 */

#ifdef USE_USBHS1
rcu_usb48m_clock_config(IDX_USBHS1, RCU_USB48MSRC_PLL0R);
#endif /* USE_USBHS1 */

#else
/* enable IRC48M clock */
rcu_osci_on(RCU_IRC48M);

/* wait till IRC48M is ready */
while (SUCCESS != rcu_osci_stab_wait(RCU_IRC48M)) {
}

#ifdef USE_USBHS0
rcu_usb48m_clock_config(IDX_USBHS0, RCU_USB48MSRC_IRC48M);
#endif /* USE_USBHS0 */

#ifdef USE_USBHS1
rcu_usb48m_clock_config(IDX_USBHS1, RCU_USB48MSRC_IRC48M);
#endif /* USE_USBHS1 */

#endif /* USE_IRC48M */

#endif /* USE_USB_FS */

#ifdef USE_USBHS0
rcu_periph_clock_enable(RCU_USBHS0);
#endif /* USE_USBHS0 */

#ifdef USE_USBHS1
rcu_periph_clock_enable(RCU_USBHS1);
#endif /* USE_USBHS1 */

#ifdef USE_ULPI_PHY
#ifdef USE_USBHS0
rcu_periph_clock_enable(RCU_USBHS0ULPI);
#endif

#ifdef USE_USBHS1
rcu_periph_clock_enable(RCU_USBHS1ULPI);
#endif
#endif /* USE_ULPI_PHY */
}

rcu的配置如下，主要用于配置USB時鐘，USB需要一個穩定的48M時鐘，歷程中根據相關宏定義開關進行選擇配置。

Usb timer的配置如下，主要用于延遲。

注冊HID接口操作函數如下所示。在該代碼清單中，注冊了HID接口操作的配置以及數據處理函數句柄，用于后續函數調用。

USBD內核初始化函數如下所示。在該代碼清單中，首先配置設備類callback函數，之后創建字符串，配置USB以及初始化USB內核，斷開USB連接，初始化USB設備模式，之后設置USB連接，將USB連接狀態配置為DEFAULT默認狀態，啟動狀態機。

配置USB中斷函數如下。

內部上拉電阻被上拉后，主機將會對設備進行枚舉，設備端采用while (USBD_CONFIGURED != hid_keyboard.dev.cur_status) 語句進行等待。當USB設備狀態變為USBD_CONFIGURED狀態時，表明設備枚舉完成。

枚舉完成之后，程序將進入主循環中，在主循環中，循環調用HID USB模擬鍵盤數據處理函數，在該函數中，首先判斷上次傳輸是否完成，完成之后通過掃描按鍵的方式查看按鍵是否被按下，若按鍵被按下，則通過hid_report_send()函數發送鍵盤報告數據。

報文發送函數定義如下，該函數包含三個參數，udev為初始化后的設備操作結構體；report為發送報告緩沖區地址；len為發送報告的長度。在該函數中，如果設備已經被枚舉成功，則首先將prev_transfer_complete標志位設置為0，表明接下來將進行發送數據，數據并未發送完成，之后，調用usbd_ep_send()將需要發送的報告拷貝到USB外設緩沖區中并設置端點為有效狀態，等待主機發送IN令牌包，USB設備將外設緩沖區中的數據發送給主機。

當數據發送完成，USB設備將調用hid_data_in()函數進行數據處理。該函數程序如下所示。在該函數中，首先判斷hid->data[2]的數據是否為0x00，如果不為0x00表明上次發送的為按鍵按下的鍵值，還需發送按鍵松開的鍵值，如果為0x00表明上次按鍵按下和松開的鍵值均已發送完成，之后將prev_transfer_complete設置為1，表明上一次的按鍵數據傳輸完成，可進行下次按鍵數據傳輸。

13.5實驗結果

將本例程燒錄到海棠派開發板中，通過Type C數據線連接開發板和PC，之后分別按下WKUP和USER按鍵，將會向PC發送A、B鍵值。

本教程由GD32 MCU方案商聚沃科技原創發布，了解更多GD32 MCU教程，關注聚沃科技官網