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 --- quantum/os_detection.c | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'quantum/os_detection.c') diff --git a/quantum/os_detection.c b/quantum/os_detection.c index 99ffe1927a..4196b3ec8a 100644 --- a/quantum/os_detection.c +++ b/quantum/os_detection.c @@ -65,8 +65,8 @@ static volatile os_variant_t reported_os = OS_UNSURE; static volatile bool first_report = true; // to react on USB state changes -static volatile enum usb_device_state current_usb_device_state = USB_DEVICE_STATE_NO_INIT; -static volatile enum usb_device_state maxprev_usb_device_state = USB_DEVICE_STATE_NO_INIT; +static volatile struct usb_device_state current_usb_device_state = {.configure_state = USB_DEVICE_STATE_NO_INIT}; +static volatile struct usb_device_state maxprev_usb_device_state = {.configure_state = USB_DEVICE_STATE_NO_INIT}; // the OS detection might be unstable for a while, "debounce" it static volatile bool debouncing = false; @@ -88,7 +88,7 @@ void os_detection_task(void) { return; } #endif - if (current_usb_device_state == USB_DEVICE_STATE_CONFIGURED) { + if (current_usb_device_state.configure_state == USB_DEVICE_STATE_CONFIGURED) { // debouncing goes for both the detected OS as well as the USB state if (debouncing && timer_elapsed_fast(last_time) >= OS_DETECTION_DEBOUNCE) { debouncing = false; @@ -163,19 +163,19 @@ os_variant_t detected_host_os(void) { void erase_wlength_data(void) { memset(&setups_data, 0, sizeof(setups_data)); - detected_os = OS_UNSURE; - reported_os = OS_UNSURE; - current_usb_device_state = USB_DEVICE_STATE_NO_INIT; - maxprev_usb_device_state = USB_DEVICE_STATE_NO_INIT; - debouncing = false; - last_time = 0; - first_report = true; + detected_os = OS_UNSURE; + reported_os = OS_UNSURE; + current_usb_device_state.configure_state = USB_DEVICE_STATE_NO_INIT; + maxprev_usb_device_state.configure_state = USB_DEVICE_STATE_NO_INIT; + debouncing = false; + last_time = 0; + first_report = true; } -void os_detection_notify_usb_device_state_change(enum usb_device_state usb_device_state) { +void os_detection_notify_usb_device_state_change(struct usb_device_state usb_device_state) { // treat this like any other source of instability - if (maxprev_usb_device_state < current_usb_device_state) { - maxprev_usb_device_state = current_usb_device_state; + if (maxprev_usb_device_state.configure_state < current_usb_device_state.configure_state) { + maxprev_usb_device_state.configure_state = current_usb_device_state.configure_state; } current_usb_device_state = usb_device_state; last_time = timer_read_fast(); -- cgit v1.2.3