feat: 添加USB HID模块支持
- 添加usb_hid_event事件定义和实现，用于管理USB HID状态 - 添加usb_hid_module模块，实现USB HID协议栈的完整生命周期管理 - 在CMakeLists.txt中注册新的事件和模块源文件 - 在设备树overlay中配置三个HID设备：HID_BOOT、HID_NKRO、HID_RAW - 在prj.conf中启用USB设备栈相关配置选项 - 修复电池模块和模式切换模块中的重复挂起问题 - 改进蓝牙绑定模块的错误处理和日志记录 - 在app.overlay中启用usbd节点并添加PMIC配置调整
This commit is contained in:
546
src/modules/usb_hid_module.c
Normal file
546
src/modules/usb_hid_module.c
Normal file
@@ -0,0 +1,546 @@
|
||||
#include <errno.h>
|
||||
#include <string.h>
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/kernel.h>
|
||||
#include <zephyr/usb/class/usbd_hid.h>
|
||||
#include <zephyr/usb/usbd.h>
|
||||
|
||||
#include <app_event_manager.h>
|
||||
#include <caf/events/power_event.h>
|
||||
|
||||
#define MODULE usb_hid
|
||||
#include <caf/events/module_state_event.h>
|
||||
|
||||
#include "hid_report_descriptor.h"
|
||||
#include "mode_event.h"
|
||||
#include "usb_hid_event.h"
|
||||
|
||||
#include <zephyr/logging/log.h>
|
||||
LOG_MODULE_REGISTER(MODULE, LOG_LEVEL_INF);
|
||||
|
||||
#define APP_USB_VID 0x1209
|
||||
#define APP_USB_PID 0x0001
|
||||
|
||||
/*
|
||||
* 模块目标：
|
||||
* 1) 模块内聚控制 USB HID 栈生命周期（初始化/启用/禁用），不依赖外部 usb_hid_event 控制。
|
||||
* 2) 对外统一上报 usb_hid_event，供 LED/上层状态机消费。
|
||||
* 3) 仅响应 mode_event（USB/BLE/2.4G）和 power_event（休眠/唤醒）。
|
||||
*
|
||||
* 约束：
|
||||
* - 启动时只做 USB 设备初始化，不自动 enable USB 栈；
|
||||
* - 只有当 mode 切到 USB 且系统非休眠时才 enable；
|
||||
* - BLE 逻辑保持不变，不在本模块中触碰。
|
||||
*/
|
||||
struct usb_hid_ctx {
|
||||
const struct device *boot_dev;
|
||||
const struct device *nkro_dev;
|
||||
const struct device *raw_dev;
|
||||
|
||||
bool stack_initialized;
|
||||
bool stack_enabled;
|
||||
bool stack_error;
|
||||
|
||||
bool usb_mode_selected;
|
||||
bool pm_suspended;
|
||||
|
||||
bool boot_iface_ready;
|
||||
bool nkro_iface_ready;
|
||||
bool raw_iface_ready;
|
||||
|
||||
enum usb_hid_usbd_state usbd_state;
|
||||
enum usb_hid_stack_state hid_state;
|
||||
};
|
||||
|
||||
static struct usb_hid_ctx g_usb_hid = {
|
||||
.usbd_state = USB_HID_USBD_DISCONNECTED,
|
||||
.hid_state = USB_HID_STACK_OFF,
|
||||
};
|
||||
|
||||
USBD_DEVICE_DEFINE(new_kbd_usbd,
|
||||
DEVICE_DT_GET(DT_NODELABEL(usbd)),
|
||||
APP_USB_VID, APP_USB_PID);
|
||||
USBD_DESC_LANG_DEFINE(new_kbd_lang);
|
||||
USBD_DESC_MANUFACTURER_DEFINE(new_kbd_mfr, "new_kbd");
|
||||
USBD_DESC_PRODUCT_DEFINE(new_kbd_product, "new_kbd composite HID");
|
||||
USBD_DESC_CONFIG_DEFINE(new_kbd_fs_cfg_desc, "FS Configuration");
|
||||
USBD_CONFIGURATION_DEFINE(new_kbd_fs_config, 0, 100, &new_kbd_fs_cfg_desc);
|
||||
|
||||
static const uint8_t boot_report_desc[] = HID_KEYBOARD_REPORT_DESC();
|
||||
static const uint8_t nkro_report_desc[] = HID_DESC_KEYBOARD_NKRO_CONSUMER();
|
||||
static const uint8_t raw_report_desc[] = HID_DESC_RAW_64();
|
||||
|
||||
static void publish_usb_hid_state(void)
|
||||
{
|
||||
struct usb_hid_event *event = new_usb_hid_event();
|
||||
|
||||
event->evt_type = USB_HID_EVT_STATE_REPORT;
|
||||
event->enable = g_usb_hid.stack_enabled;
|
||||
event->usbd_state = g_usb_hid.usbd_state;
|
||||
event->hid_state = g_usb_hid.hid_state;
|
||||
APP_EVENT_SUBMIT(event);
|
||||
}
|
||||
|
||||
static void recompute_hid_state(void)
|
||||
{
|
||||
enum usb_hid_stack_state new_hid_state;
|
||||
|
||||
if (g_usb_hid.stack_error) {
|
||||
new_hid_state = USB_HID_STACK_ERROR;
|
||||
} else if (g_usb_hid.pm_suspended && g_usb_hid.stack_enabled) {
|
||||
new_hid_state = USB_HID_STACK_SUSPENDED;
|
||||
} else if (!g_usb_hid.stack_initialized) {
|
||||
new_hid_state = USB_HID_STACK_OFF;
|
||||
} else if (g_usb_hid.stack_enabled &&
|
||||
(g_usb_hid.boot_iface_ready ||
|
||||
g_usb_hid.nkro_iface_ready ||
|
||||
g_usb_hid.raw_iface_ready)) {
|
||||
new_hid_state = USB_HID_STACK_ACTIVE;
|
||||
} else {
|
||||
/*
|
||||
* 栈已初始化但未进入 ACTIVE（例如刚 enable 还未配置、或 mode 切走后 disable）。
|
||||
* 用 READY 表示“协议栈可用但当前未承载有效 HID 会话”。
|
||||
*/
|
||||
new_hid_state = USB_HID_STACK_READY;
|
||||
}
|
||||
|
||||
if (g_usb_hid.hid_state != new_hid_state) {
|
||||
g_usb_hid.hid_state = new_hid_state;
|
||||
publish_usb_hid_state();
|
||||
}
|
||||
}
|
||||
|
||||
static void set_usbd_state(enum usb_hid_usbd_state state)
|
||||
{
|
||||
if (g_usb_hid.usbd_state != state) {
|
||||
g_usb_hid.usbd_state = state;
|
||||
publish_usb_hid_state();
|
||||
}
|
||||
}
|
||||
|
||||
static int hid_stub_get_report(const struct device *dev,
|
||||
uint8_t type, uint8_t id,
|
||||
uint16_t len, uint8_t *buf)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(type);
|
||||
ARG_UNUSED(id);
|
||||
ARG_UNUSED(len);
|
||||
ARG_UNUSED(buf);
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
static int hid_stub_set_report(const struct device *dev,
|
||||
uint8_t type, uint8_t id,
|
||||
uint16_t len, const uint8_t *buf)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(type);
|
||||
ARG_UNUSED(id);
|
||||
ARG_UNUSED(len);
|
||||
ARG_UNUSED(buf);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void hid_stub_set_idle(const struct device *dev, uint8_t id, uint32_t duration)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(id);
|
||||
ARG_UNUSED(duration);
|
||||
}
|
||||
|
||||
static uint32_t hid_stub_get_idle(const struct device *dev, uint8_t id)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(id);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void hid_stub_set_protocol(const struct device *dev, uint8_t proto)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(proto);
|
||||
}
|
||||
|
||||
static void hid_stub_input_done(const struct device *dev, const uint8_t *report)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(report);
|
||||
}
|
||||
|
||||
static void hid_stub_output_report(const struct device *dev, uint16_t len, const uint8_t *buf)
|
||||
{
|
||||
ARG_UNUSED(dev);
|
||||
ARG_UNUSED(len);
|
||||
ARG_UNUSED(buf);
|
||||
}
|
||||
|
||||
static void hid_iface_ready_cb(const struct device *dev, bool ready)
|
||||
{
|
||||
if (dev == g_usb_hid.boot_dev) {
|
||||
g_usb_hid.boot_iface_ready = ready;
|
||||
} else if (dev == g_usb_hid.nkro_dev) {
|
||||
g_usb_hid.nkro_iface_ready = ready;
|
||||
} else if (dev == g_usb_hid.raw_dev) {
|
||||
g_usb_hid.raw_iface_ready = ready;
|
||||
}
|
||||
|
||||
if (ready) {
|
||||
set_usbd_state(USB_HID_USBD_CONNECTED);
|
||||
}
|
||||
|
||||
recompute_hid_state();
|
||||
}
|
||||
|
||||
static const struct hid_device_ops boot_hid_ops = {
|
||||
.iface_ready = hid_iface_ready_cb,
|
||||
.get_report = hid_stub_get_report,
|
||||
.set_report = hid_stub_set_report,
|
||||
.set_idle = hid_stub_set_idle,
|
||||
.get_idle = hid_stub_get_idle,
|
||||
.set_protocol = hid_stub_set_protocol,
|
||||
.input_report_done = hid_stub_input_done,
|
||||
.output_report = hid_stub_output_report,
|
||||
};
|
||||
|
||||
static const struct hid_device_ops report_hid_ops = {
|
||||
.iface_ready = hid_iface_ready_cb,
|
||||
.get_report = hid_stub_get_report,
|
||||
.set_report = hid_stub_set_report,
|
||||
.set_idle = hid_stub_set_idle,
|
||||
.get_idle = hid_stub_get_idle,
|
||||
.input_report_done = hid_stub_input_done,
|
||||
.output_report = hid_stub_output_report,
|
||||
};
|
||||
|
||||
static const struct hid_device_ops raw_hid_ops = {
|
||||
.iface_ready = hid_iface_ready_cb,
|
||||
.get_report = hid_stub_get_report,
|
||||
.set_report = hid_stub_set_report,
|
||||
.set_idle = hid_stub_set_idle,
|
||||
.get_idle = hid_stub_get_idle,
|
||||
.input_report_done = hid_stub_input_done,
|
||||
.output_report = hid_stub_output_report,
|
||||
};
|
||||
|
||||
static void usbd_msg_cb(struct usbd_context *const usbd_ctx,
|
||||
const struct usbd_msg *const msg)
|
||||
{
|
||||
switch (msg->type) {
|
||||
case USBD_MSG_VBUS_READY:
|
||||
set_usbd_state(USB_HID_USBD_CONNECTED);
|
||||
/*
|
||||
* 只有在 USB 模式下才允许拉起 USB 栈。
|
||||
* 这样即使插着线，只要用户切到 BLE/2.4G，也不会强制进入 USB HID。
|
||||
*/
|
||||
if (usbd_can_detect_vbus(usbd_ctx) && g_usb_hid.stack_enabled) {
|
||||
(void)usbd_enable(usbd_ctx);
|
||||
}
|
||||
break;
|
||||
|
||||
case USBD_MSG_VBUS_REMOVED:
|
||||
set_usbd_state(USB_HID_USBD_DISCONNECTED);
|
||||
break;
|
||||
|
||||
case USBD_MSG_SUSPEND:
|
||||
set_usbd_state(USB_HID_USBD_SUSPENDED);
|
||||
break;
|
||||
|
||||
case USBD_MSG_RESUME:
|
||||
set_usbd_state(USB_HID_USBD_CONNECTED);
|
||||
break;
|
||||
|
||||
case USBD_MSG_CONFIGURATION:
|
||||
set_usbd_state(USB_HID_USBD_CONNECTED);
|
||||
break;
|
||||
|
||||
case USBD_MSG_UDC_ERROR:
|
||||
case USBD_MSG_STACK_ERROR:
|
||||
LOG_ERR("USBD stack error message: %d", msg->type);
|
||||
g_usb_hid.stack_error = true;
|
||||
recompute_hid_state();
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
static bool usb_hid_devices_ready(void)
|
||||
{
|
||||
if (!device_is_ready(g_usb_hid.boot_dev)) {
|
||||
LOG_ERR("HID boot device is not ready");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!device_is_ready(g_usb_hid.nkro_dev)) {
|
||||
LOG_ERR("HID nkro device is not ready");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!device_is_ready(g_usb_hid.raw_dev)) {
|
||||
LOG_ERR("HID raw device is not ready");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!device_is_ready(DEVICE_DT_GET(DT_NODELABEL(usbd)))) {
|
||||
LOG_ERR("USBD device is not ready");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
static int usb_hid_register_hid_devices(void)
|
||||
{
|
||||
int err = hid_device_register(g_usb_hid.boot_dev,
|
||||
boot_report_desc, sizeof(boot_report_desc),
|
||||
&boot_hid_ops);
|
||||
if (err) {
|
||||
LOG_ERR("hid_device_register(boot) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = hid_device_register(g_usb_hid.nkro_dev,
|
||||
nkro_report_desc, sizeof(nkro_report_desc),
|
||||
&report_hid_ops);
|
||||
if (err) {
|
||||
LOG_ERR("hid_device_register(nkro) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = hid_device_register(g_usb_hid.raw_dev,
|
||||
raw_report_desc, sizeof(raw_report_desc),
|
||||
&raw_hid_ops);
|
||||
if (err) {
|
||||
LOG_ERR("hid_device_register(raw) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int usb_hid_configure_usbd(void)
|
||||
{
|
||||
int err = usbd_add_descriptor(&new_kbd_usbd, &new_kbd_lang);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_add_descriptor(lang) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usbd_add_descriptor(&new_kbd_usbd, &new_kbd_mfr);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_add_descriptor(mfr) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usbd_add_descriptor(&new_kbd_usbd, &new_kbd_product);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_add_descriptor(product) failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usbd_add_configuration(&new_kbd_usbd, USBD_SPEED_FS, &new_kbd_fs_config);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_add_configuration failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usbd_register_all_classes(&new_kbd_usbd, USBD_SPEED_FS, 1, NULL);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_register_all_classes failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int usb_hid_init_usbd_stack(void)
|
||||
{
|
||||
int err;
|
||||
|
||||
usbd_device_set_code_triple(&new_kbd_usbd, USBD_SPEED_FS, 0, 0, 0);
|
||||
|
||||
err = usbd_msg_register_cb(&new_kbd_usbd, usbd_msg_cb);
|
||||
if (err) {
|
||||
LOG_ERR("usbd_msg_register_cb failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usbd_init(&new_kbd_usbd);
|
||||
if (err && (err != -EALREADY)) {
|
||||
LOG_ERR("usbd_init failed: %d", err);
|
||||
return err;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int usb_hid_stack_init(void)
|
||||
{
|
||||
if (g_usb_hid.stack_initialized) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
g_usb_hid.boot_dev = DEVICE_DT_GET(DT_NODELABEL(hid_dev_0));
|
||||
g_usb_hid.nkro_dev = DEVICE_DT_GET(DT_NODELABEL(hid_dev_1));
|
||||
g_usb_hid.raw_dev = DEVICE_DT_GET(DT_NODELABEL(raw_hid));
|
||||
|
||||
if (!usb_hid_devices_ready()) {
|
||||
return -ENODEV;
|
||||
}
|
||||
|
||||
int err = usb_hid_register_hid_devices();
|
||||
if (err) {
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usb_hid_configure_usbd();
|
||||
if (err) {
|
||||
return err;
|
||||
}
|
||||
|
||||
err = usb_hid_init_usbd_stack();
|
||||
if (err) {
|
||||
return err;
|
||||
}
|
||||
|
||||
g_usb_hid.stack_initialized = true;
|
||||
recompute_hid_state();
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int usb_hid_set_enabled(bool enable)
|
||||
{
|
||||
int err;
|
||||
|
||||
if (!g_usb_hid.stack_initialized) {
|
||||
err = usb_hid_stack_init();
|
||||
if (err) {
|
||||
return err;
|
||||
}
|
||||
}
|
||||
|
||||
if (g_usb_hid.stack_enabled == enable) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
g_usb_hid.stack_enabled = enable;
|
||||
|
||||
if (enable) {
|
||||
err = usbd_enable(&new_kbd_usbd);
|
||||
} else {
|
||||
err = usbd_disable(&new_kbd_usbd);
|
||||
g_usb_hid.boot_iface_ready = false;
|
||||
g_usb_hid.nkro_iface_ready = false;
|
||||
g_usb_hid.raw_iface_ready = false;
|
||||
set_usbd_state(USB_HID_USBD_DISCONNECTED);
|
||||
}
|
||||
|
||||
if (err && (err != -EALREADY)) {
|
||||
LOG_ERR("usbd_%s failed: %d", enable ? "enable" : "disable", err);
|
||||
g_usb_hid.stack_error = true;
|
||||
recompute_hid_state();
|
||||
return err;
|
||||
}
|
||||
|
||||
recompute_hid_state();
|
||||
publish_usb_hid_state();
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void refresh_usb_state_by_policy(void)
|
||||
{
|
||||
/*
|
||||
* 控制策略：
|
||||
* - USB 模式 + 非休眠：启用 USB HID。
|
||||
* - 其他情况：关闭 USB HID（不销毁初始化结果，后续可快速恢复）。
|
||||
*/
|
||||
bool should_enable = g_usb_hid.usb_mode_selected && !g_usb_hid.pm_suspended;
|
||||
int err = usb_hid_set_enabled(should_enable);
|
||||
|
||||
if (err) {
|
||||
LOG_ERR("usb_hid_set_enabled(%d) failed: %d", should_enable, err);
|
||||
}
|
||||
}
|
||||
|
||||
static bool handle_module_state_event(const struct module_state_event *event)
|
||||
{
|
||||
if (!check_state(event, MODULE_ID(main), MODULE_STATE_READY)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
int err = usb_hid_stack_init();
|
||||
if (err) {
|
||||
LOG_ERR("USB HID stack init failed: %d", err);
|
||||
g_usb_hid.stack_error = true;
|
||||
module_set_state(MODULE_STATE_ERROR);
|
||||
recompute_hid_state();
|
||||
return false;
|
||||
}
|
||||
|
||||
module_set_state(MODULE_STATE_READY);
|
||||
publish_usb_hid_state();
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool handle_mode_event(const struct mode_event *event)
|
||||
{
|
||||
g_usb_hid.usb_mode_selected = (event->mode_type == MODE_TYPE_USB);
|
||||
refresh_usb_state_by_policy();
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool handle_power_down_event(void)
|
||||
{
|
||||
if (g_usb_hid.pm_suspended) {
|
||||
/* 避免重复上报 STANDBY 导致 power_manager 在 SUSPENDING 期间反复迭代。 */
|
||||
return false;
|
||||
}
|
||||
|
||||
g_usb_hid.pm_suspended = true;
|
||||
refresh_usb_state_by_policy();
|
||||
module_set_state(MODULE_STATE_STANDBY);
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool handle_wake_up_event(void)
|
||||
{
|
||||
if (!g_usb_hid.pm_suspended) {
|
||||
return false;
|
||||
}
|
||||
|
||||
g_usb_hid.pm_suspended = false;
|
||||
refresh_usb_state_by_policy();
|
||||
module_set_state(MODULE_STATE_READY);
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool app_event_handler(const struct app_event_header *aeh)
|
||||
{
|
||||
if (is_module_state_event(aeh)) {
|
||||
return handle_module_state_event(cast_module_state_event(aeh));
|
||||
}
|
||||
|
||||
if (is_mode_event(aeh)) {
|
||||
return handle_mode_event(cast_mode_event(aeh));
|
||||
}
|
||||
|
||||
if (is_power_down_event(aeh)) {
|
||||
return handle_power_down_event();
|
||||
}
|
||||
|
||||
if (is_wake_up_event(aeh)) {
|
||||
return handle_wake_up_event();
|
||||
}
|
||||
|
||||
__ASSERT_NO_MSG(false);
|
||||
return false;
|
||||
}
|
||||
|
||||
APP_EVENT_LISTENER(MODULE, app_event_handler);
|
||||
APP_EVENT_SUBSCRIBE(MODULE, module_state_event);
|
||||
APP_EVENT_SUBSCRIBE(MODULE, mode_event);
|
||||
APP_EVENT_SUBSCRIBE_EARLY(MODULE, power_down_event);
|
||||
APP_EVENT_SUBSCRIBE(MODULE, wake_up_event);
|
||||
Reference in New Issue
Block a user