Add raw_hid support to host driver (#25255)

This commit is contained in:
Joel Challis 2025-05-11 23:38:48 +01:00 committed by GitHub
parent c045c3e00c
commit 88c094908b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 95 additions and 36 deletions

View File

@ -643,6 +643,11 @@ ifeq ($(strip $(VIA_ENABLE)), yes)
TRI_LAYER_ENABLE := yes
endif
ifeq ($(strip $(RAW_ENABLE)), yes)
OPT_DEFS += -DRAW_ENABLE
SRC += raw_hid.c
endif
ifeq ($(strip $(DYNAMIC_KEYMAP_ENABLE)), yes)
SEND_STRING_ENABLE := yes
endif

View File

@ -28,3 +28,5 @@ __attribute__((weak)) void bluetooth_send_mouse(report_mouse_t *report) {}
__attribute__((weak)) void bluetooth_send_consumer(uint16_t usage) {}
__attribute__((weak)) void bluetooth_send_system(uint16_t usage) {}
__attribute__((weak)) void bluetooth_send_raw_hid(uint8_t *data, uint8_t length) {}

View File

@ -81,3 +81,11 @@ void bluetooth_send_consumer(uint16_t usage);
* \param usage The system usage to send.
*/
void bluetooth_send_system(uint16_t usage);
/**
* \brief Send a raw_hid packet.
*
* \param data A pointer to the buffer to be sent. Always 32 bytes in length.
* \param length The length of the buffer. Always 32.
*/
void bluetooth_send_raw_hid(uint8_t *data, uint8_t length);

15
quantum/raw_hid.c Normal file
View File

@ -0,0 +1,15 @@
// Copyright 2025 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "raw_hid.h"
#include "host.h"
void raw_hid_send(uint8_t *data, uint8_t length) {
host_raw_hid_send(data, length);
}
__attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) {
// Users should #include "raw_hid.h" in their own code
// and implement this function there. Leave this as weak linkage
// so users can opt to not handle data coming in.
}

View File

@ -33,10 +33,6 @@ ifeq ($(strip $(PROGRAMMABLE_BUTTON_ENABLE)), yes)
SHARED_EP_ENABLE = yes
endif
ifeq ($(strip $(RAW_ENABLE)), yes)
OPT_DEFS += -DRAW_ENABLE
endif
ifeq ($(strip $(CONSOLE_ENABLE)), yes)
OPT_DEFS += -DCONSOLE_ENABLE
else

View File

@ -66,9 +66,19 @@ void send_keyboard(report_keyboard_t *report);
void send_nkro(report_nkro_t *report);
void send_mouse(report_mouse_t *report);
void send_extra(report_extra_t *report);
void send_raw_hid(uint8_t *data, uint8_t length);
/* host struct */
host_driver_t chibios_driver = {.keyboard_leds = usb_device_state_get_leds, .send_keyboard = send_keyboard, .send_nkro = send_nkro, .send_mouse = send_mouse, .send_extra = send_extra};
host_driver_t chibios_driver = {
.keyboard_leds = usb_device_state_get_leds,
.send_keyboard = send_keyboard,
.send_nkro = send_nkro,
.send_mouse = send_mouse,
.send_extra = send_extra,
#ifdef RAW_ENABLE
.send_raw_hid = send_raw_hid,
#endif
};
#ifdef VIRTSER_ENABLE
void virtser_task(void);

View File

@ -32,6 +32,10 @@
#include "usb_driver.h"
#include "usb_types.h"
#ifdef RAW_ENABLE
# include "raw_hid.h"
#endif
#ifdef NKRO_ENABLE
# include "keycode_config.h"
@ -515,19 +519,13 @@ void console_task(void) {
#endif /* CONSOLE_ENABLE */
#ifdef RAW_ENABLE
void raw_hid_send(uint8_t *data, uint8_t length) {
void send_raw_hid(uint8_t *data, uint8_t length) {
if (length != RAW_EPSIZE) {
return;
}
send_report(USB_ENDPOINT_IN_RAW, data, length);
}
__attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) {
// Users should #include "raw_hid.h" in their own code
// and implement this function there. Leave this as weak linkage
// so users can opt to not handle data coming in.
}
void raw_hid_task(void) {
uint8_t buffer[RAW_EPSIZE];
while (receive_report(USB_ENDPOINT_OUT_RAW, buffer, sizeof(buffer))) {

View File

@ -55,6 +55,9 @@ host_driver_t bt_driver = {
.send_nkro = bluetooth_send_nkro,
.send_mouse = bluetooth_send_mouse,
.send_extra = bluetooth_send_extra,
# ifdef RAW_ENABLE
.send_raw_hid = bluetooth_send_raw_hid,
# endif
};
#endif
@ -299,6 +302,15 @@ void host_programmable_button_send(uint32_t data) {
__attribute__((weak)) void send_programmable_button(report_programmable_button_t *report) {}
#ifdef RAW_ENABLE
void host_raw_hid_send(uint8_t *data, uint8_t length) {
host_driver_t *driver = host_get_active_driver();
if (!driver || !driver->send_raw_hid) return;
(*driver->send_raw_hid)(data, length);
}
#endif
uint16_t host_last_system_usage(void) {
return last_system_usage;
}

View File

@ -41,6 +41,7 @@ void host_mouse_send(report_mouse_t *report);
void host_system_send(uint16_t usage);
void host_consumer_send(uint16_t usage);
void host_programmable_button_send(uint32_t data);
void host_raw_hid_send(uint8_t *data, uint8_t length);
uint16_t host_last_system_usage(void);
uint16_t host_last_consumer_usage(void);

View File

@ -29,6 +29,9 @@ typedef struct {
void (*send_nkro)(report_nkro_t *);
void (*send_mouse)(report_mouse_t *);
void (*send_extra)(report_extra_t *);
#ifdef RAW_ENABLE
void (*send_raw_hid)(uint8_t *, uint8_t);
#endif
} host_driver_t;
void send_joystick(report_joystick_t *report);

View File

@ -75,11 +75,24 @@
static report_keyboard_t keyboard_report_sent;
/* Host driver */
static void send_keyboard(report_keyboard_t *report);
static void send_nkro(report_nkro_t *report);
static void send_mouse(report_mouse_t *report);
static void send_extra(report_extra_t *report);
host_driver_t lufa_driver = {.keyboard_leds = usb_device_state_get_leds, .send_keyboard = send_keyboard, .send_nkro = send_nkro, .send_mouse = send_mouse, .send_extra = send_extra};
static void send_keyboard(report_keyboard_t *report);
static void send_nkro(report_nkro_t *report);
static void send_mouse(report_mouse_t *report);
static void send_extra(report_extra_t *report);
#ifdef RAW_ENABLE
static void send_raw_hid(uint8_t *data, uint8_t length);
#endif
host_driver_t lufa_driver = {
.keyboard_leds = usb_device_state_get_leds,
.send_keyboard = send_keyboard,
.send_nkro = send_nkro,
.send_mouse = send_mouse,
.send_extra = send_extra,
#ifdef RAW_ENABLE
.send_raw_hid = send_raw_hid,
#endif
};
void send_report(uint8_t endpoint, void *report, size_t size) {
uint8_t timeout = 255;
@ -131,21 +144,11 @@ USB_ClassInfo_CDC_Device_t cdc_device = {
*
* FIXME: Needs doc
*/
void raw_hid_send(uint8_t *data, uint8_t length) {
static void send_raw_hid(uint8_t *data, uint8_t length) {
if (length != RAW_EPSIZE) return;
send_report(RAW_IN_EPNUM, data, RAW_EPSIZE);
}
/** \brief Raw HID Receive
*
* FIXME: Needs doc
*/
__attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) {
// Users should #include "raw_hid.h" in their own code
// and implement this function there. Leave this as weak linkage
// so users can opt to not handle data coming in.
}
/** \brief Raw HID Task
*
* FIXME: Needs doc

View File

@ -144,7 +144,7 @@ static void send_report(uint8_t endpoint, void *report, size_t size) {
static uint8_t raw_output_buffer[RAW_BUFFER_SIZE];
static uint8_t raw_output_received_bytes = 0;
void raw_hid_send(uint8_t *data, uint8_t length) {
static void send_raw_hid(uint8_t *data, uint8_t length) {
if (length != RAW_BUFFER_SIZE) {
return;
}
@ -152,12 +152,6 @@ void raw_hid_send(uint8_t *data, uint8_t length) {
send_report(4, data, 32);
}
__attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) {
// Users should #include "raw_hid.h" in their own code
// and implement this function there. Leave this as weak linkage
// so users can opt to not handle data coming in.
}
void raw_hid_task(void) {
usbPoll();
@ -213,8 +207,20 @@ static void send_keyboard(report_keyboard_t *report);
static void send_nkro(report_nkro_t *report);
static void send_mouse(report_mouse_t *report);
static void send_extra(report_extra_t *report);
#ifdef RAW_ENABLE
static void send_raw_hid(uint8_t *data, uint8_t length);
#endif
static host_driver_t driver = {.keyboard_leds = usb_device_state_get_leds, .send_keyboard = send_keyboard, .send_nkro = send_nkro, .send_mouse = send_mouse, .send_extra = send_extra};
static host_driver_t driver = {
.keyboard_leds = usb_device_state_get_leds,
.send_keyboard = send_keyboard,
.send_nkro = send_nkro,
.send_mouse = send_mouse,
.send_extra = send_extra,
#ifdef RAW_ENABLE
.send_raw_hid = send_raw_hid,
#endif
};
host_driver_t *vusb_driver(void) {
return &driver;