diff options
author | Stefan Kerkmann <[email protected]> | 2024-10-18 09:57:08 +0200 |
---|---|---|
committer | GitHub <[email protected]> | 2024-10-18 09:57:08 +0200 |
commit | 3f9d4644126483bbd937f2be75a8878a1c986630 (patch) | |
tree | 0c91e51941b048b87c816e05f36e8a6b50753b9b /tmk_core/protocol/usb_device_state.h | |
parent | 80f8aae3ec733cfbd6957a70f5fe436e5b92e725 (diff) | |
download | qmk_firmware-3f9d4644126483bbd937f2be75a8878a1c986630.tar.gz qmk_firmware-3f9d4644126483bbd937f2be75a8878a1c986630.zip |
[Core] `usb_device_state`: consolidate usb state handling across implementations (#24258)
* 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 <[email protected]>
* 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 <[email protected]>
* keyboards: fix oversize warnings
Signed-off-by: Stefan Kerkmann <[email protected]>
---------
Signed-off-by: Stefan Kerkmann <[email protected]>
Diffstat (limited to 'tmk_core/protocol/usb_device_state.h')
-rw-r--r-- | tmk_core/protocol/usb_device_state.h | 41 |
1 files changed, 31 insertions, 10 deletions
diff --git a/tmk_core/protocol/usb_device_state.h b/tmk_core/protocol/usb_device_state.h index 3be65ea7e1..6d12f144fe 100644 --- a/tmk_core/protocol/usb_device_state.h +++ b/tmk_core/protocol/usb_device_state.h @@ -20,20 +20,41 @@ #include <stdbool.h> #include <stdint.h> -void usb_device_state_set_configuration(bool isConfigured, uint8_t configurationNumber); -void usb_device_state_set_suspend(bool isConfigured, uint8_t configurationNumber); -void usb_device_state_set_resume(bool isConfigured, uint8_t configurationNumber); -void usb_device_state_set_reset(void); -void usb_device_state_init(void); - -enum usb_device_state { +typedef enum { USB_DEVICE_STATE_NO_INIT = 0, // We're in this state before calling usb_device_state_init() USB_DEVICE_STATE_INIT = 1, // Can consume up to 100mA USB_DEVICE_STATE_CONFIGURED = 2, // Can consume up to what is specified in configuration descriptor, typically 500mA USB_DEVICE_STATE_SUSPEND = 3 // Can consume only suspend current +} usb_configure_state_t; + +typedef enum { + USB_PROTOCOL_BOOT = 0, + USB_PROTOCOL_REPORT = 1, +} usb_hid_protocol_t; + +// note: we can't typedef this struct to usb_device_state_t because it would +// conflict with the previous definition in: +// lib/chibios-contrib/ext/nxp-middleware-usb/device/usb_device.h +struct usb_device_state { + uint8_t idle_rate; + uint8_t leds; + usb_hid_protocol_t protocol; + usb_configure_state_t configure_state; }; -extern enum usb_device_state usb_device_state; +void usb_device_state_set_configuration(bool is_configured, uint8_t configuration_number); +void usb_device_state_set_suspend(bool is_configured, uint8_t configuration_number); +void usb_device_state_set_resume(bool is_configured, uint8_t configuration_number); +void usb_device_state_set_reset(void); +void usb_device_state_init(void); +usb_configure_state_t usb_device_state_get_configure_state(void); +void usb_device_state_set_protocol(usb_hid_protocol_t protocol); +usb_hid_protocol_t usb_device_state_get_protocol(void); +void usb_device_state_set_leds(uint8_t leds); +uint8_t usb_device_state_get_leds(void); +void usb_device_state_set_idle_rate(uint8_t idle_rate); +uint8_t usb_device_state_get_idle_rate(void); +void usb_device_state_reset_hid_state(void); -void notify_usb_device_state_change_kb(enum usb_device_state usb_device_state); -void notify_usb_device_state_change_user(enum usb_device_state usb_device_state); +void notify_usb_device_state_change_kb(struct usb_device_state usb_device_state); +void notify_usb_device_state_change_user(struct usb_device_state usb_device_state); |