Rust USB HID设备开发库usbd-hid的使用指南

完整示例代码

下面是一个完整的嵌入式USB HID键盘设备示例，基于STM32微控制器：

// src/main.rs
#![no_std]
#![no_main]

use panic_halt as _;
use cortex_m_rt::entry;
use stm32f1xx_hal::{prelude::*, pac, usb::{Peripheral, UsbBus}};
use usb_device::prelude::*;
use usbd_hid::descriptor::KeyboardReport;
use usbd_hid::hid_class::HidClass;

#[entry]
fn main() -> ! {
    // 初始化硬件
    let dp = pac::Peripherals::take().unwrap();
    let mut flash = dp.FLASH.constrain();
    let mut rcc = dp.RCC.constrain();
    
    // 配置时钟
    let clocks = rcc.cfgr
        .use_hse(8.MHz())
        .sysclk(48.MHz())
        .pclk1(24.MHz())
        .freeze(&mut flash.acr);
    
    // 配置GPIO
    let mut gpioa = dp.GPIOA.split(&mut rcc.apb2);
    
    // 配置USB外设
    let usb_dm = gpioa.pa11.into_floating_input(&mut gpioa.crh);
    let usb_dp = gpioa.pa12.into_floating_input(&mut gpioa.crh);
    let usb = Peripheral { usb: dp.USB, pin_dm: usb_dm, pin_dp: usb_dp };
    
    // 创建USB总线
    let usb_bus = UsbBus::new(usb);
    
    // 创建HID键盘设备
    let mut keyboard = HidKeyboard::new(usb_bus);
    
    // 主循环
    loop {
        // 轮询USB事件
        keyboard.poll();
        
        // 模拟按键按下'A'
        keyboard.send_key(0x04); // 0x04是HID键盘'A'的键码
        
        // 简单延时
        cortex_m::asm::delay(8_000_000);
    }
}

struct HidKeyboard {
    usb_dev: UsbDevice<'static, UsbBus<Peripheral>>,
    hid: HidClass<'static, UsbBus<Peripheral>, KeyboardReport>,
}

impl HidKeyboard {
    fn new(usb_bus: &'static UsbBus<Peripheral>) -> HidKeyboard {
        // 创建HID类实例
        let hid = HidClass::new(usb_bus, KeyboardReport::desc(), 60);
        
        // 创建USB设备
        let usb_dev = UsbDeviceBuilder::new(usb_bus, UsbVidPid(0x16c0, 0x27dd))
            .manufacturer("Rust HID")
            .product("Keyboard")
            .serial_number("1.0")
            .device_class(0)
            .build();
            
        HidKeyboard { usb_dev, hid }
    }
    
    fn send_key(&mut self, key: u8) {
        // 创建键盘报告
        let report = KeyboardReport {
            modifier: 0,       // 无修饰键
            reserved: 0,       // 保留位
            leds: 0,           // LED状态
            keycodes: [key, 0, 0, 0, 0, 0], // 最多6个按键
        };
        
        // 发送报告
        self.hid.push_input(&report).ok();
        
        // 发送空报告表示按键释放
        let release_report = KeyboardReport {
            modifier: 0,
            reserved: 0,
            leds: 0,
            keycodes: [0, 0, 0, 0, 0, 0],
        };
        
        self.hid.push_input(&release_report).ok();
    }
    
    fn poll(&mut self) {
        // 轮询USB事件
        if !self.usb_dev.poll(&mut [&mut self.hid]) {
            return;
        }
        
        // 检查USB状态
        match self.usb_dev.state() {
            UsbDeviceState::Configured => {
                // 设备已配置，可以发送报告
            }
            _ => {
                // 其他状态处理
            }
        }
    }
}

项目配置文件

Cargo.toml

[package]
name = "stm32-hid-keyboard"
version = "0.1.0"
edition = "2021"

[dependencies]
cortex-m = "0.7"
cortex-m-rt = "0.7"
panic-halt = "0.2"
stm32f1xx-hal = { version = "0.8", features = ["rt", "stm32f103", "medium"] }
usb-device = "0.3"
usbd-hid = "0.7"

.cargo/config.toml (嵌入式目标配置)

[target.thumbv7m-none-eabi]
runner = "probe-rs run --chip STM32F103C8"

[build]
target = "thumbv7m-none-eabi"

代码说明

1. 硬件初始化:

   • 配置STM32的时钟系统
   • 初始化USB外设所需的GPIO引脚

2. USB配置:

   • 创建USB总线实例
   • 设置USB设备的VID/PID、厂商信息等

3. HID键盘实现:

   • 使用KeyboardReport结构体定义键盘报告格式
   • 实现按键发送功能，包括按键按下和释放
   • 处理USB状态变化

4. 主循环:

   • 定期轮询USB事件
   • 模拟按键按下操作

这个完整示例展示了如何在STM32微控制器上创建一个简单的USB HID键盘设备。实际使用时，可以根据需要修改按键处理逻辑或添加更多功能。