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/tests/os_detection.cpp | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'quantum/os_detection/tests/os_detection.cpp') diff --git a/quantum/os_detection/tests/os_detection.cpp b/quantum/os_detection/tests/os_detection.cpp index a9f671156b..ea43de144c 100644 --- a/quantum/os_detection/tests/os_detection.cpp +++ b/quantum/os_detection/tests/os_detection.cpp @@ -253,9 +253,11 @@ TEST_F(OsDetectionTest, TestDoNotReportIfUsbUnstable) { EXPECT_EQ(detected_host_os(), OS_LINUX); } +static struct usb_device_state usb_device_state_configured = {.configure_state = USB_DEVICE_STATE_CONFIGURED}; + TEST_F(OsDetectionTest, TestReportAfterDebounce) { EXPECT_EQ(check_sequence({0xFF, 0xFF, 0xFF, 0xFE}), OS_LINUX); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); os_detection_task(); assert_not_reported(); @@ -291,7 +293,7 @@ TEST_F(OsDetectionTest, TestReportAfterDebounce) { TEST_F(OsDetectionTest, TestReportAfterDebounceLongWait) { EXPECT_EQ(check_sequence({0x12, 0xFF, 0xFF, 0x4, 0x10, 0xFF, 0xFF, 0xFF, 0x4, 0x10, 0x20A, 0x20A, 0x20A, 0x20A, 0x20A, 0x20A}), OS_WINDOWS); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); os_detection_task(); assert_not_reported(); @@ -318,7 +320,7 @@ TEST_F(OsDetectionTest, TestReportAfterDebounceLongWait) { TEST_F(OsDetectionTest, TestReportUnsure) { EXPECT_EQ(check_sequence({0x12, 0xFF}), OS_UNSURE); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); os_detection_task(); assert_not_reported(); @@ -345,7 +347,7 @@ TEST_F(OsDetectionTest, TestReportUnsure) { TEST_F(OsDetectionTest, TestDoNotReportIntermediateResults) { EXPECT_EQ(check_sequence({0x12, 0xFF}), OS_UNSURE); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); os_detection_task(); assert_not_reported(); @@ -356,7 +358,7 @@ TEST_F(OsDetectionTest, TestDoNotReportIntermediateResults) { // at this stage, the final result has not been reached yet EXPECT_EQ(check_sequence({0xFF}), OS_LINUX); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); advance_time(OS_DETECTION_DEBOUNCE - 1); os_detection_task(); assert_not_reported(); @@ -365,7 +367,7 @@ TEST_F(OsDetectionTest, TestDoNotReportIntermediateResults) { // the remainder is processed EXPECT_EQ(check_sequence({0x4, 0x10, 0xFF, 0xFF, 0xFF, 0x4, 0x10, 0x20A, 0x20A, 0x20A, 0x20A, 0x20A, 0x20A}), OS_WINDOWS); - os_detection_notify_usb_device_state_change(USB_DEVICE_STATE_CONFIGURED); + os_detection_notify_usb_device_state_change(usb_device_state_configured); advance_time(OS_DETECTION_DEBOUNCE - 1); os_detection_task(); assert_not_reported(); -- cgit v1.2.3