From 3f9d4644126483bbd937f2be75a8878a1c986630 Mon Sep 17 00:00:00 2001 From: Stefan Kerkmann Date: Fri, 18 Oct 2024 09:57:08 +0200 Subject: [Core] `usb_device_state`: consolidate usb state handling across implementations (#24258) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * usb_device_state: add idle_rate, led and protocol Previously all usb drivers and platform implementations (expect for our oddball atsam) tracked the same two global variables: - keyboard_protocol: to indicate if we are in report or boot protocol - keyboard_idle: for the idle_rate of the keyboard endpoint And a local variable that was exposed trough some indirection: - keyboard_led_state: for the currently set indicator leds (caps lock etc.) These have all been moved into the usb_device_state struct wich is accessible by getters and setters. This reduces code duplication and centralizes the state management across platforms and drivers. Signed-off-by: Stefan Kerkmann * usb_device_state: reset protocol on reset The usb hid specification section 7.2.6 states: When initialized, all devices default to report protocol. However the host should not make any assumptions about the device’s state and should set the desired protocol whenever initializing a device. Thus on reset we should always do exactly that. Signed-off-by: Stefan Kerkmann * keyboards: fix oversize warnings Signed-off-by: Stefan Kerkmann --------- Signed-off-by: Stefan Kerkmann --- tmk_core/protocol/usb_device_state.c | 55 ++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 12 deletions(-) (limited to 'tmk_core/protocol/usb_device_state.c') diff --git a/tmk_core/protocol/usb_device_state.c b/tmk_core/protocol/usb_device_state.c index 4cd241528d..98ccfbc902 100644 --- a/tmk_core/protocol/usb_device_state.c +++ b/tmk_core/protocol/usb_device_state.c @@ -24,15 +24,15 @@ # include "os_detection.h" #endif -enum usb_device_state usb_device_state = USB_DEVICE_STATE_NO_INIT; +static struct usb_device_state usb_device_state = {.idle_rate = 0, .leds = 0, .protocol = USB_PROTOCOL_REPORT, .configure_state = USB_DEVICE_STATE_NO_INIT}; -__attribute__((weak)) void notify_usb_device_state_change_kb(enum usb_device_state usb_device_state) { +__attribute__((weak)) void notify_usb_device_state_change_kb(struct usb_device_state usb_device_state) { notify_usb_device_state_change_user(usb_device_state); } -__attribute__((weak)) void notify_usb_device_state_change_user(enum usb_device_state usb_device_state) {} +__attribute__((weak)) void notify_usb_device_state_change_user(struct usb_device_state usb_device_state) {} -static void notify_usb_device_state_change(enum usb_device_state usb_device_state) { +static void notify_usb_device_state_change(struct usb_device_state usb_device_state) { #if defined(HAPTIC_ENABLE) && HAPTIC_OFF_IN_LOW_POWER haptic_notify_usb_device_state_change(); #endif @@ -44,27 +44,58 @@ static void notify_usb_device_state_change(enum usb_device_state usb_device_stat #endif } -void usb_device_state_set_configuration(bool isConfigured, uint8_t configurationNumber) { - usb_device_state = isConfigured ? USB_DEVICE_STATE_CONFIGURED : USB_DEVICE_STATE_INIT; +void usb_device_state_set_configuration(bool is_configured, uint8_t configuration_number) { + usb_device_state.configure_state = is_configured ? USB_DEVICE_STATE_CONFIGURED : USB_DEVICE_STATE_INIT; notify_usb_device_state_change(usb_device_state); } -void usb_device_state_set_suspend(bool isConfigured, uint8_t configurationNumber) { - usb_device_state = USB_DEVICE_STATE_SUSPEND; +void usb_device_state_set_suspend(bool is_configured, uint8_t configuration_number) { + usb_device_state.configure_state = USB_DEVICE_STATE_SUSPEND; notify_usb_device_state_change(usb_device_state); } -void usb_device_state_set_resume(bool isConfigured, uint8_t configurationNumber) { - usb_device_state = isConfigured ? USB_DEVICE_STATE_CONFIGURED : USB_DEVICE_STATE_INIT; +void usb_device_state_set_resume(bool is_configured, uint8_t configuration_number) { + usb_device_state.configure_state = is_configured ? USB_DEVICE_STATE_CONFIGURED : USB_DEVICE_STATE_INIT; notify_usb_device_state_change(usb_device_state); } void usb_device_state_set_reset(void) { - usb_device_state = USB_DEVICE_STATE_INIT; + usb_device_state.configure_state = USB_DEVICE_STATE_INIT; notify_usb_device_state_change(usb_device_state); } void usb_device_state_init(void) { - usb_device_state = USB_DEVICE_STATE_INIT; + usb_device_state.configure_state = USB_DEVICE_STATE_INIT; notify_usb_device_state_change(usb_device_state); } + +inline usb_configure_state_t usb_device_state_get_configure_state(void) { + return usb_device_state.configure_state; +} + +void usb_device_state_set_protocol(usb_hid_protocol_t protocol) { + usb_device_state.protocol = protocol == USB_PROTOCOL_BOOT ? USB_PROTOCOL_BOOT : USB_PROTOCOL_REPORT; + notify_usb_device_state_change(usb_device_state); +} + +inline usb_hid_protocol_t usb_device_state_get_protocol() { + return usb_device_state.protocol; +} + +void usb_device_state_set_leds(uint8_t leds) { + usb_device_state.leds = leds; + notify_usb_device_state_change(usb_device_state); +} + +inline uint8_t usb_device_state_get_leds(void) { + return usb_device_state.leds; +} + +void usb_device_state_set_idle_rate(uint8_t idle_rate) { + usb_device_state.idle_rate = idle_rate; + notify_usb_device_state_change(usb_device_state); +} + +inline uint8_t usb_device_state_get_idle_rate(void) { + return usb_device_state.idle_rate; +} -- cgit v1.2.3