实战经验 | 基于 STM32U5 创建 USBx_CustomHID 通信

只看该作者 · 2024-4-24 10:50

本帖最后由 STM新闻官于 2024-4-24 18:23 编辑

1. 前言

某客户在使用 STM32U5 开发一款产品时需要使用到 USB Custom 进行双向通信，并反馈 STM32U5 使用的是 Azure USBx 协议栈，不再支持 ST USB device 库。客户表示只熟悉 ST USB Device 库，对 USBx 协议栈与 API 没有任何使用经验。查阅目前所有 USBx 的例程，发现目前 USBx 均没有可参考的 Custom HID 双向通信范例，客户希望提供使用 USBx HID 进行双向通信的例程，这里简单介绍下利用 CubeMx 创建工程的实现过程。

2. USB 双向通信的几个基本知识点

首先，我们回顾一下 USB2.0 设备端与主机通信的基本原理及数据流，如下图所示。

设备描述符：向主机提供 USB 版本信息、支持的协议、供应商标识(VID)、产品标识(PID)、及制造商和产品字符串，支持的配置数量等信息。配置描述符：提供特定设备配置的信息，如接口数量、设备由总线供电还是自供电、设备能否启动一个远程唤醒以及设备功耗。接口描述符：对配置描述符中的接口信息进行描述，主要包括了接口号、类型以及该接口中的端点(Endpoints)数量等信息。

端点描述符：用于向主机提供端点信息，主要包括了端点方向(IN/OUT)、传输类型(中断、批量 bluck、同步、控制)以及数据包最大长度等信息。

3. USBx HID 设备端 API 介绍

USBx Device 协议栈内部实现了一套复杂的基于事件和消息驱动机制的数据流传输和控制传输逻辑，用户 Application 只需要使用其提供的 APIs 即可实现 USB 通信。USBx Device Stack 所提供的 APIs 如下：

4. USBx 实现 Custom HID 双向通信的步骤

(一) 系统外设、USB、USBx、Threadx 的添加和基础配置下面我们就使用 NUCELO-U575ZI-Q 基于前面所讲的 USBx Device stack APIs 来实现 USB HID 双向通信。使用 STM32CubeMX 创建如下工程，工程基本配置如下。

USB 和 RCC 时钟系统配置如下：

配置 NUCLEO-U575-Q 为 SMPS 供电模式

配置 USB 引脚及中断功能

添加 ThreadX RTOS 协议栈

添加 USBx 协议栈支持并配置协议栈

设置 MX_USB_OTG_FS_PCD_Init 在 main()中不进行调用，并保存工程并生成代码。

(二) 代码的添加及修改

本例程目的是实现 USB Custom HID 双向通信。本例程共使用了 3 个 Endpoint，如下：Eendpoint0(控制类型，IN/OUT)、Endpoint1(中断，IN)、Endpoint2(中断,OUT)。Endpoint0：系统默认控制管理端点，用于 Host 对 Device 传输控制和管理命令，如设备描述符、配置描述符等系统信息进行配置和查询。

Endpoint1：输入(IN)类型端点，用于向 Host 发送数据，在本例程我们创建了一个应用线程 usbx_cutomhid_thread_entry()，以 1S 为周期向 Host 通过 Endpoint1 发送 64 字节的数据包。

Endpoint2：输出(OUT)类型端点，用于当 Host 向 device 发送数据时，USBx Stack 会自动调用 USBD_Custom_HID_SetReport()的回调函数，通过 Endpoint2 来接收 Host 所发送的数据包。

1. 在 app_usbx_devich.h 中包含如下几个头文件。

2. 在 app_usbx_device.c 中申明和定义如下结构，其中 ux_app_MsgQueue 消息队列用于实现 USB 的动态管理。

3. 在 ux_device_customhid.h/.c 中添加如下申明和定义，并在相关相关函数内分别依次添加下图所示代码。其中线程 usbx_cutomhid_thread_entry 用于周期性通过 Endpoint1 向 host 发送 64 字节数据。

修改 HID SetReport 函数，接收由 PC 机向 OUT 端点(Endpoint2)发送的数据包。

在 usbx_customhid_thread_entry 中实现 IN 端点(Endpoint1)向 PC 机 1S 发送一次数据功能。

添加 HID report 描述符，我们使用 USB 官网 HID 报告描述符工具生成自定义 Custom HID report 描述符，该工具可以到网址 https://www.usb.org/document-library/hid-descriptortool 下载。

根据 USB 规范一个 HID 报告描述符至少应包括如下条目(Items)。