diff options
author | Stefan Kerkmann <[email protected]> | 2024-02-28 12:00:27 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2024-02-28 22:00:27 +1100 |
commit | 0e02b0c41e47d5f5ad799a9860869b9d30ab881a (patch) | |
tree | 4b9cf95e22162db622ea049ea96bc0d15358cf9f /tmk_core/protocol/chibios/usb_main.c | |
parent | b43f6cb7ef33f38ee494f639e2704a25c1e68332 (diff) | |
download | qmk_firmware-0e02b0c41e47d5f5ad799a9860869b9d30ab881a.tar.gz qmk_firmware-0e02b0c41e47d5f5ad799a9860869b9d30ab881a.zip |
[Core] Refactor ChibiOS USB endpoints to be fully async (#21656)
Diffstat (limited to 'tmk_core/protocol/chibios/usb_main.c')
-rw-r--r-- | tmk_core/protocol/chibios/usb_main.c | 814 |
1 files changed, 200 insertions, 614 deletions
diff --git a/tmk_core/protocol/chibios/usb_main.c b/tmk_core/protocol/chibios/usb_main.c index 7b1e641213..ced5fd4fc2 100644 --- a/tmk_core/protocol/chibios/usb_main.c +++ b/tmk_core/protocol/chibios/usb_main.c @@ -1,45 +1,32 @@ -/* - * (c) 2015 flabberast <[email protected]> - * - * Based on the following work: - * - Guillaume Duc's raw hid example (MIT License) - * https://github.com/guiduc/usb-hid-chibios-example - * - PJRC Teensy examples (MIT License) - * https://www.pjrc.com/teensy/usb_keyboard.html - * - hasu's TMK keyboard code (GPL v2 and some code Modified BSD) - * https://github.com/tmk/tmk_keyboard/ - * - ChibiOS demo code (Apache 2.0 License) - * http://www.chibios.org - * - * Since some GPL'd code is used, this work is licensed under - * GPL v2 or later. - */ - -/* - * Implementation notes: - * - * USBEndpointConfig - Configured using explicit order instead of struct member name. - * This is due to ChibiOS hal LLD differences, which is dependent on hardware, - * "USBv1" devices have `ep_buffers` and "OTGv1" have `in_multiplier`. - * Given `USBv1/hal_usb_lld.h` marks the field as "not currently used" this code file - * makes the assumption this is safe to avoid littering with preprocessor directives. - */ +// Copyright 2023 Stefan Kerkmann +// Copyright 2020-2021 Ryan (@fauxpark) +// Copyright 2020 Nick Brassel (@tzarc) +// Copyright 2020 a-chol +// Copyright 2020 xyzz +// Copyright 2020 Joel Challis (@zvecr) +// Copyright 2020 George (@goshdarnharris) +// Copyright 2018 James Laird-Wah +// Copyright 2018 Drashna Jaelre (@drashna) +// Copyright 2016 Fredizzimo +// Copyright 2016 Giovanni Di Sirio +// SPDX-License-Identifier: GPL-3.0-or-later OR Apache-2.0 #include <ch.h> #include <hal.h> #include <string.h> #include "usb_main.h" +#include "usb_report_handling.h" #include "host.h" -#include "chibios_config.h" -#include "debug.h" #include "suspend.h" +#include "timer.h" #ifdef SLEEP_LED_ENABLE # include "sleep_led.h" # include "led.h" #endif #include "wait.h" +#include "usb_endpoints.h" #include "usb_device_state.h" #include "usb_descriptor.h" #include "usb_driver.h" @@ -51,11 +38,6 @@ extern keymap_config_t keymap_config; #endif -#if defined(CONSOLE_ENABLE) -# define RBUF_SIZE 256 -# include "ring_buffer.h" -#endif - /* --------------------------------------------------------- * Global interface variables and declarations * --------------------------------------------------------- @@ -69,33 +51,16 @@ extern keymap_config_t keymap_config; # define usb_lld_disconnect_bus(usbp) #endif -uint8_t keyboard_idle __attribute__((aligned(2))) = 0; -uint8_t keyboard_protocol __attribute__((aligned(2))) = 1; -uint8_t keyboard_led_state = 0; -volatile uint16_t keyboard_idle_count = 0; -static virtual_timer_t keyboard_idle_timer; - -static void keyboard_idle_timer_cb(struct ch_virtual_timer *, void *arg); +extern usb_endpoint_in_t usb_endpoints_in[USB_ENDPOINT_IN_COUNT]; +extern usb_endpoint_out_t usb_endpoints_out[USB_ENDPOINT_OUT_COUNT]; -report_keyboard_t keyboard_report_sent = {0}; -report_mouse_t mouse_report_sent = {0}; +uint8_t _Alignas(2) keyboard_idle = 0; +uint8_t _Alignas(2) keyboard_protocol = 1; +uint8_t keyboard_led_state = 0; -union { - uint8_t report_id; - report_keyboard_t keyboard; -#ifdef EXTRAKEY_ENABLE - report_extra_t extra; -#endif -#ifdef MOUSE_ENABLE - report_mouse_t mouse; -#endif -#ifdef DIGITIZER_ENABLE - report_digitizer_t digitizer; -#endif -#ifdef JOYSTICK_ENABLE - report_joystick_t joystick; -#endif -} universal_report_blank = {0}; +static bool __attribute__((__unused__)) send_report_buffered(usb_endpoint_in_lut_t endpoint, void *report, size_t size); +static void __attribute__((__unused__)) flush_report_buffered(usb_endpoint_in_lut_t endpoint, bool padded); +static bool __attribute__((__unused__)) receive_report(usb_endpoint_out_lut_t endpoint, void *report, size_t size); /* --------------------------------------------------------- * Descriptors and USB driver objects @@ -109,6 +74,11 @@ union { NULL, /* SETUP buffer (not a SETUP endpoint) */ #endif +/* + * Handles the GET_DESCRIPTOR callback + * + * Returns the proper descriptor + */ static const USBDescriptor *usb_get_descriptor_cb(USBDriver *usbp, uint8_t dtype, uint8_t dindex, uint16_t wIndex) { usb_control_request_t *setup = (usb_control_request_t *)usbp->setup; @@ -123,299 +93,6 @@ static const USBDescriptor *usb_get_descriptor_cb(USBDriver *usbp, uint8_t dtype return &descriptor; } -/* - * USB notification callback that does nothing. Needed to work around bugs in - * some USB LLDs that fail to resume the waiting thread when the notification - * callback pointer is NULL. - */ -static void dummy_usb_cb(USBDriver *usbp, usbep_t ep) { - (void)usbp; - (void)ep; -} - -#ifndef KEYBOARD_SHARED_EP -/* keyboard endpoint state structure */ -static USBInEndpointState kbd_ep_state; -/* keyboard endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig kbd_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - KEYBOARD_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &kbd_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP) -/* mouse endpoint state structure */ -static USBInEndpointState mouse_ep_state; - -/* mouse endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig mouse_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - MOUSE_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &mouse_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#ifdef SHARED_EP_ENABLE -/* shared endpoint state structure */ -static USBInEndpointState shared_ep_state; - -/* shared endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig shared_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - SHARED_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &shared_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#if defined(JOYSTICK_ENABLE) && !defined(JOYSTICK_SHARED_EP) -/* joystick endpoint state structure */ -static USBInEndpointState joystick_ep_state; - -/* joystick endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig joystick_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - JOYSTICK_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &joystick_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#if defined(DIGITIZER_ENABLE) && !defined(DIGITIZER_SHARED_EP) -/* digitizer endpoint state structure */ -static USBInEndpointState digitizer_ep_state; - -/* digitizer endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig digitizer_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - DIGITIZER_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &digitizer_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#ifdef CONSOLE_ENABLE -/* Console endpoint state structure */ -static USBInEndpointState console_ep_state; - -/* Console endpoint initialization structure (IN) - see USBEndpointConfig comment at top of file */ -static const USBEndpointConfig console_ep_config = { - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ - NULL, /* SETUP packet notification callback */ - dummy_usb_cb, /* IN notification callback */ - NULL, /* OUT notification callback */ - CONSOLE_EPSIZE, /* IN maximum packet size */ - 0, /* OUT maximum packet size */ - &console_ep_state, /* IN Endpoint state */ - NULL, /* OUT endpoint state */ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ -}; -#endif - -#ifdef USB_ENDPOINTS_ARE_REORDERABLE -typedef struct { - size_t queue_capacity_in; - size_t queue_capacity_out; - USBInEndpointState in_ep_state; - USBOutEndpointState out_ep_state; - USBInEndpointState int_ep_state; - USBEndpointConfig inout_ep_config; - USBEndpointConfig int_ep_config; - const QMKUSBConfig config; - QMKUSBDriver driver; -} usb_driver_config_t; -#else -typedef struct { - size_t queue_capacity_in; - size_t queue_capacity_out; - USBInEndpointState in_ep_state; - USBOutEndpointState out_ep_state; - USBInEndpointState int_ep_state; - USBEndpointConfig in_ep_config; - USBEndpointConfig out_ep_config; - USBEndpointConfig int_ep_config; - const QMKUSBConfig config; - QMKUSBDriver driver; -} usb_driver_config_t; -#endif - -#ifdef USB_ENDPOINTS_ARE_REORDERABLE -/* Reusable initialization structure - see USBEndpointConfig comment at top of file */ -# define QMK_USB_DRIVER_CONFIG(stream, notification, fixedsize) \ - { \ - .queue_capacity_in = stream##_IN_CAPACITY, .queue_capacity_out = stream##_OUT_CAPACITY, \ - .inout_ep_config = \ - { \ - stream##_IN_MODE, /* Interrupt EP */ \ - NULL, /* SETUP packet notification callback */ \ - qmkusbDataTransmitted, /* IN notification callback */ \ - qmkusbDataReceived, /* OUT notification callback */ \ - stream##_EPSIZE, /* IN maximum packet size */ \ - stream##_EPSIZE, /* OUT maximum packet size */ \ - NULL, /* IN Endpoint state */ \ - NULL, /* OUT endpoint state */ \ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ \ - }, \ - .int_ep_config = \ - { \ - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ \ - NULL, /* SETUP packet notification callback */ \ - qmkusbInterruptTransmitted, /* IN notification callback */ \ - NULL, /* OUT notification callback */ \ - CDC_NOTIFICATION_EPSIZE, /* IN maximum packet size */ \ - 0, /* OUT maximum packet size */ \ - NULL, /* IN Endpoint state */ \ - NULL, /* OUT endpoint state */ \ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ \ - }, \ - .config = { \ - .usbp = &USB_DRIVER, \ - .bulk_in = stream##_IN_EPNUM, \ - .bulk_out = stream##_OUT_EPNUM, \ - .int_in = notification, \ - .in_buffers = stream##_IN_CAPACITY, \ - .out_buffers = stream##_OUT_CAPACITY, \ - .in_size = stream##_EPSIZE, \ - .out_size = stream##_EPSIZE, \ - .fixed_size = fixedsize, \ - .ib = (__attribute__((aligned(4))) uint8_t[BQ_BUFFER_SIZE(stream##_IN_CAPACITY, stream##_EPSIZE)]){}, \ - .ob = (__attribute__((aligned(4))) uint8_t[BQ_BUFFER_SIZE(stream##_OUT_CAPACITY, stream##_EPSIZE)]){}, \ - } \ - } -#else -/* Reusable initialization structure - see USBEndpointConfig comment at top of file */ -# define QMK_USB_DRIVER_CONFIG(stream, notification, fixedsize) \ - { \ - .queue_capacity_in = stream##_IN_CAPACITY, .queue_capacity_out = stream##_OUT_CAPACITY, \ - .in_ep_config = \ - { \ - stream##_IN_MODE, /* Interrupt EP */ \ - NULL, /* SETUP packet notification callback */ \ - qmkusbDataTransmitted, /* IN notification callback */ \ - NULL, /* OUT notification callback */ \ - stream##_EPSIZE, /* IN maximum packet size */ \ - 0, /* OUT maximum packet size */ \ - NULL, /* IN Endpoint state */ \ - NULL, /* OUT endpoint state */ \ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ \ - }, \ - .out_ep_config = \ - { \ - stream##_OUT_MODE, /* Interrupt EP */ \ - NULL, /* SETUP packet notification callback */ \ - NULL, /* IN notification callback */ \ - qmkusbDataReceived, /* OUT notification callback */ \ - 0, /* IN maximum packet size */ \ - stream##_EPSIZE, /* OUT maximum packet size */ \ - NULL, /* IN Endpoint state */ \ - NULL, /* OUT endpoint state */ \ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ \ - }, \ - .int_ep_config = \ - { \ - USB_EP_MODE_TYPE_INTR, /* Interrupt EP */ \ - NULL, /* SETUP packet notification callback */ \ - qmkusbInterruptTransmitted, /* IN notification callback */ \ - NULL, /* OUT notification callback */ \ - CDC_NOTIFICATION_EPSIZE, /* IN maximum packet size */ \ - 0, /* OUT maximum packet size */ \ - NULL, /* IN Endpoint state */ \ - NULL, /* OUT endpoint state */ \ - usb_lld_endpoint_fields /* USB driver specific endpoint fields */ \ - }, \ - .config = { \ - .usbp = &USB_DRIVER, \ - .bulk_in = stream##_IN_EPNUM, \ - .bulk_out = stream##_OUT_EPNUM, \ - .int_in = notification, \ - .in_buffers = stream##_IN_CAPACITY, \ - .out_buffers = stream##_OUT_CAPACITY, \ - .in_size = stream##_EPSIZE, \ - .out_size = stream##_EPSIZE, \ - .fixed_size = fixedsize, \ - .ib = (__attribute__((aligned(4))) uint8_t[BQ_BUFFER_SIZE(stream##_IN_CAPACITY, stream##_EPSIZE)]){}, \ - .ob = (__attribute__((aligned(4))) uint8_t[BQ_BUFFER_SIZE(stream##_OUT_CAPACITY, stream##_EPSIZE)]){}, \ - } \ - } -#endif - -typedef struct { - union { - struct { -#ifdef RAW_ENABLE - usb_driver_config_t raw_driver; -#endif -#ifdef MIDI_ENABLE - usb_driver_config_t midi_driver; -#endif -#ifdef VIRTSER_ENABLE - usb_driver_config_t serial_driver; -#endif - }; - usb_driver_config_t array[0]; - }; -} usb_driver_configs_t; - -static usb_driver_configs_t drivers = { -#ifdef RAW_ENABLE -# ifndef RAW_IN_CAPACITY -# define RAW_IN_CAPACITY 4 -# endif -# ifndef RAW_OUT_CAPACITY -# define RAW_OUT_CAPACITY 4 -# endif -# define RAW_IN_MODE USB_EP_MODE_TYPE_INTR -# define RAW_OUT_MODE USB_EP_MODE_TYPE_INTR - .raw_driver = QMK_USB_DRIVER_CONFIG(RAW, 0, false), -#endif - -#ifdef MIDI_ENABLE -# define MIDI_STREAM_IN_CAPACITY 4 -# define MIDI_STREAM_OUT_CAPACITY 4 -# define MIDI_STREAM_IN_MODE USB_EP_MODE_TYPE_BULK -# define MIDI_STREAM_OUT_MODE USB_EP_MODE_TYPE_BULK - .midi_driver = QMK_USB_DRIVER_CONFIG(MIDI_STREAM, 0, false), -#endif - -#ifdef VIRTSER_ENABLE -# define CDC_IN_CAPACITY 4 -# define CDC_OUT_CAPACITY 4 -# define CDC_IN_MODE USB_EP_MODE_TYPE_BULK -# define CDC_OUT_MODE USB_EP_MODE_TYPE_BULK - .serial_driver = QMK_USB_DRIVER_CONFIG(CDC, CDC_NOTIFICATION_EPNUM, false), -#endif -}; - -#define NUM_USB_DRIVERS (sizeof(drivers) / sizeof(usb_driver_config_t)) - /* --------------------------------------------------------- * USB driver functions * --------------------------------------------------------- @@ -507,36 +184,11 @@ static void usb_event_cb(USBDriver *usbp, usbevent_t event) { case USB_EVENT_CONFIGURED: osalSysLockFromISR(); - /* Enable the endpoints specified into the configuration. */ -#ifndef KEYBOARD_SHARED_EP - usbInitEndpointI(usbp, KEYBOARD_IN_EPNUM, &kbd_ep_config); -#endif -#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP) - usbInitEndpointI(usbp, MOUSE_IN_EPNUM, &mouse_ep_config); -#endif -#ifdef SHARED_EP_ENABLE - usbInitEndpointI(usbp, SHARED_IN_EPNUM, &shared_ep_config); -#endif -#if defined(JOYSTICK_ENABLE) && !defined(JOYSTICK_SHARED_EP) - usbInitEndpointI(usbp, JOYSTICK_IN_EPNUM, &joystick_ep_config); -#endif -#if defined(DIGITIZER_ENABLE) && !defined(DIGITIZER_SHARED_EP) - usbInitEndpointI(usbp, DIGITIZER_IN_EPNUM, &digitizer_ep_config); -#endif -#ifdef CONSOLE_ENABLE - usbInitEndpointI(usbp, CONSOLE_IN_EPNUM, &console_ep_config); -#endif - for (int i = 0; i < NUM_USB_DRIVERS; i++) { -#ifdef USB_ENDPOINTS_ARE_REORDERABLE - usbInitEndpointI(usbp, drivers.array[i].config.bulk_in, &drivers.array[i].inout_ep_config); -#else - usbInitEndpointI(usbp, drivers.array[i].config.bulk_in, &drivers.array[i].in_ep_config); - usbInitEndpointI(usbp, drivers.array[i].config.bulk_out, &drivers.array[i].out_ep_config); -#endif - if (drivers.array[i].config.int_in) { - usbInitEndpointI(usbp, drivers.array[i].config.int_in, &drivers.array[i].int_ep_config); - } - qmkusbConfigureHookI(&drivers.array[i].driver); + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_configure_cb(&usb_endpoints_in[i]); + } + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_configure_cb(&usb_endpoints_out[i]); } osalSysUnlockFromISR(); if (last_suspend_state) { @@ -550,22 +202,25 @@ static void usb_event_cb(USBDriver *usbp, usbevent_t event) { /* Falls into.*/ case USB_EVENT_RESET: usb_event_queue_enqueue(event); - for (int i = 0; i < NUM_USB_DRIVERS; i++) { - chSysLockFromISR(); - /* Disconnection event on suspend.*/ - qmkusbSuspendHookI(&drivers.array[i].driver); - chSysUnlockFromISR(); + chSysLockFromISR(); + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_suspend_cb(&usb_endpoints_in[i]); } + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_suspend_cb(&usb_endpoints_out[i]); + } + chSysUnlockFromISR(); return; case USB_EVENT_WAKEUP: - // TODO: from ISR! print("[W]"); - for (int i = 0; i < NUM_USB_DRIVERS; i++) { - chSysLockFromISR(); - /* Disconnection event on suspend.*/ - qmkusbWakeupHookI(&drivers.array[i].driver); - chSysUnlockFromISR(); + chSysLockFromISR(); + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_wakeup_cb(&usb_endpoints_in[i]); + } + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_wakeup_cb(&usb_endpoints_out[i]); } + chSysUnlockFromISR(); usb_event_queue_enqueue(USB_EVENT_WAKEUP); return; @@ -587,7 +242,7 @@ static void usb_event_cb(USBDriver *usbp, usbevent_t event) { * Other Device Required Optional Optional Optional Optional Optional */ -static uint8_t set_report_buf[2] __attribute__((aligned(4))); +static uint8_t _Alignas(4) set_report_buf[2]; static void set_led_transfer_cb(USBDriver *usbp) { usb_control_request_t *setup = (usb_control_request_t *)usbp->setup; @@ -611,41 +266,7 @@ static bool usb_requests_hook_cb(USBDriver *usbp) { case USB_RTYPE_DIR_DEV2HOST: switch (setup->bRequest) { case HID_REQ_GetReport: - switch (setup->wIndex) { -#ifndef KEYBOARD_SHARED_EP - case KEYBOARD_INTERFACE: - usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, KEYBOARD_REPORT_SIZE, NULL); - return TRUE; - break; -#endif -#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP) - case MOUSE_INTERFACE: - usbSetupTransfer(usbp, (uint8_t *)&mouse_report_sent, sizeof(mouse_report_sent), NULL); - return TRUE; - break; -#endif -#ifdef SHARED_EP_ENABLE - case SHARED_INTERFACE: -# ifdef KEYBOARD_SHARED_EP - if (setup->wValue.lbyte == REPORT_ID_KEYBOARD) { - usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, KEYBOARD_REPORT_SIZE, NULL); - return true; - } -# endif -# ifdef MOUSE_SHARED_EP - if (setup->wValue.lbyte == REPORT_ID_MOUSE) { - usbSetupTransfer(usbp, (uint8_t *)&mouse_report_sent, sizeof(mouse_report_sent), NULL); - return true; - } -# endif -#endif /* SHARED_EP_ENABLE */ - default: - universal_report_blank.report_id = setup->wValue.lbyte; - usbSetupTransfer(usbp, (uint8_t *)&universal_report_blank, setup->wLength, NULL); - return true; - } - break; - + return usb_get_report_cb(usbp); case HID_REQ_GetProtocol: if (setup->wIndex == KEYBOARD_INTERFACE) { usbSetupTransfer(usbp, &keyboard_protocol, sizeof(uint8_t), NULL); @@ -654,10 +275,8 @@ static bool usb_requests_hook_cb(USBDriver *usbp) { break; case HID_REQ_GetIdle: - usbSetupTransfer(usbp, &keyboard_idle, sizeof(uint8_t), NULL); - return true; + return usb_get_idle_cb(usbp); } - break; case USB_RTYPE_DIR_HOST2DEV: switch (setup->bRequest) { @@ -671,38 +290,15 @@ static bool usb_requests_hook_cb(USBDriver *usbp) { return true; } break; - case HID_REQ_SetProtocol: if (setup->wIndex == KEYBOARD_INTERFACE) { keyboard_protocol = setup->wValue.word; -#ifdef NKRO_ENABLE - if (!keyboard_protocol && keyboard_idle) { -#else /* NKRO_ENABLE */ - if (keyboard_idle) { -#endif /* NKRO_ENABLE */ - /* arm the idle timer if boot protocol & idle */ - osalSysLockFromISR(); - chVTSetI(&keyboard_idle_timer, 4 * TIME_MS2I(keyboard_idle), keyboard_idle_timer_cb, (void *)usbp); - osalSysUnlockFromISR(); - } } usbSetupTransfer(usbp, NULL, 0, NULL); return true; - case HID_REQ_SetIdle: keyboard_idle = setup->wValue.hbyte; - /* arm the timer */ -#ifdef NKRO_ENABLE - if (!keymap_config.nkro && keyboard_idle) { -#else /* NKRO_ENABLE */ - if (keyboard_idle) { -#endif /* NKRO_ENABLE */ - osalSysLockFromISR(); - chVTSetI(&keyboard_idle_timer, 4 * TIME_MS2I(keyboard_idle), keyboard_idle_timer_cb, (void *)usbp); - osalSysUnlockFromISR(); - } - usbSetupTransfer(usbp, NULL, 0, NULL); - return true; + return usb_set_idle_cb(usbp); } break; } @@ -719,52 +315,40 @@ static bool usb_requests_hook_cb(USBDriver *usbp) { return true; } - for (int i = 0; i < NUM_USB_DRIVERS; i++) { - if (drivers.array[i].config.int_in) { - // NOTE: Assumes that we only have one serial driver - return qmkusbRequestsHook(usbp); + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + if (usb_endpoints_in[i].usb_requests_cb != NULL) { + if (usb_endpoints_in[i].usb_requests_cb(usbp)) { + return true; + } } } return false; } -static void usb_sof_cb(USBDriver *usbp) { - osalSysLockFromISR(); - for (int i = 0; i < NUM_USB_DRIVERS; i++) { - qmkusbSOFHookI(&drivers.array[i].driver); - } - osalSysUnlockFromISR(); +static __attribute__((unused)) void dummy_cb(USBDriver *usbp) { + (void)usbp; } -/* USB driver configuration */ static const USBConfig usbcfg = { usb_event_cb, /* USB events callback */ usb_get_descriptor_cb, /* Device GET_DESCRIPTOR request callback */ usb_requests_hook_cb, /* Requests hook callback */ - usb_sof_cb /* Start Of Frame callback */ +#if STM32_USB_USE_OTG1 == TRUE || STM32_USB_USE_OTG2 == TRUE + dummy_cb, /* Workaround for OTG Peripherals not servicing new interrupts + after resuming from suspend. */ +#endif }; -/* - * Initialize the USB driver - */ void init_usb_driver(USBDriver *usbp) { - for (int i = 0; i < NUM_USB_DRIVERS; i++) { -#ifdef USB_ENDPOINTS_ARE_REORDERABLE - QMKUSBDriver *driver = &drivers.array[i].driver; - drivers.array[i].inout_ep_config.in_state = &drivers.array[i].in_ep_state; - drivers.array[i].inout_ep_config.out_state = &drivers.array[i].out_ep_state; - drivers.array[i].int_ep_config.in_state = &drivers.array[i].int_ep_state; - qmkusbObjectInit(driver, &drivers.array[i].config); - qmkusbStart(driver, &drivers.array[i].config); -#else - QMKUSBDriver *driver = &drivers.array[i].driver; - drivers.array[i].in_ep_config.in_state = &drivers.array[i].in_ep_state; - drivers.array[i].out_ep_config.out_state = &drivers.array[i].out_ep_state; - drivers.array[i].int_ep_config.in_state = &drivers.array[i].int_ep_state; - qmkusbObjectInit(driver, &drivers.array[i].config); - qmkusbStart(driver, &drivers.array[i].config); -#endif + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_init(&usb_endpoints_in[i]); + usb_endpoint_in_start(&usb_endpoints_in[i]); + } + + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_init(&usb_endpoints_out[i]); + usb_endpoint_out_start(&usb_endpoints_out[i]); } /* @@ -777,23 +361,31 @@ void init_usb_driver(USBDriver *usbp) { wait_ms(50); usbStart(usbp, &usbcfg); usbConnectBus(usbp); - - chVTObjectInit(&keyboard_idle_timer); } __attribute__((weak)) void restart_usb_driver(USBDriver *usbp) { usbDisconnectBus(usbp); usbStop(usbp); -#if USB_SUSPEND_WAKEUP_DELAY > 0 - // Some hubs, kvm switches, and monitors do - // weird things, with USB device state bouncing - // around wildly on wakeup, yielding race - // conditions that can corrupt the keyboard state. - // - // Pause for a while to let things settle... - wait_ms(USB_SUSPEND_WAKEUP_DELAY); -#endif + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_stop(&usb_endpoints_in[i]); + } + + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_stop(&usb_endpoints_out[i]); + } + + wait_ms(50); + + for (int i = 0; i < USB_ENDPOINT_IN_COUNT; i++) { + usb_endpoint_in_init(&usb_endpoints_in[i]); + usb_endpoint_in_start(&usb_endpoints_in[i]); + } + + for (int i = 0; i < USB_ENDPOINT_OUT_COUNT; i++) { + usb_endpoint_out_init(&usb_endpoints_out[i]); + usb_endpoint_out_start(&usb_endpoints_out[i]); + } usbStart(usbp, &usbcfg); usbConnectBus(usbp); @@ -804,81 +396,78 @@ __attribute__((weak)) void restart_usb_driver(USBDriver *usbp) { * --------------------------------------------------------- */ -/* Idle requests timer code - * callback (called from ISR, unlocked state) */ -static void keyboard_idle_timer_cb(struct ch_virtual_timer *timer, void *arg) { - (void)timer; - USBDriver *usbp = (USBDriver *)arg; - - osalSysLockFromISR(); - - /* check that the states of things are as they're supposed to */ - if (usbGetDriverStateI(usbp) != USB_ACTIVE) { - /* do not rearm the timer, should be enabled on IDLE request */ - osalSysUnlockFromISR(); - return; - } - -#ifdef NKRO_ENABLE - if (!keymap_config.nkro && keyboard_idle && keyboard_protocol) { -#else /* NKRO_ENABLE */ - if (keyboard_idle && keyboard_protocol) { -#endif /* NKRO_ENABLE */ - /* TODO: are we sure we want the KBD_ENDPOINT? */ - if (!usbGetTransmitStatusI(usbp, KEYBOARD_IN_EPNUM)) { - usbStartTransmitI(usbp, KEYBOARD_IN_EPNUM, (uint8_t *)&keyboard_report_sent, KEYBOARD_EPSIZE); - } - /* rearm the timer */ - chVTSetI(&keyboard_idle_timer, 4 * TIME_MS2I(keyboard_idle), keyboard_idle_timer_cb, (void *)usbp); - } - - /* do not rearm the timer if the condition above fails - * it should be enabled again on either IDLE or SET_PROTOCOL requests */ - osalSysUnlockFromISR(); -} - /* LED status */ uint8_t keyboard_leds(void) { return keyboard_led_state; } -void send_report(uint8_t endpoint, void *report, size_t size) { - osalSysLock(); - if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { - osalSysUnlock(); - return; - } +/** + * @brief Send a report to the host, the report is enqueued into an output + * queue and send once the USB endpoint becomes empty. + * + * @param endpoint USB IN endpoint to send the report from + * @param report pointer to the report + * @param size size of the report + * @return true Success + * @return false Failure + */ +bool send_report(usb_endpoint_in_lut_t endpoint, void *report, size_t size) { + return usb_endpoint_in_send(&usb_endpoints_in[endpoint], (uint8_t *)report, size, TIME_MS2I(100), false); +} - if (usbGetTransmitStatusI(&USB_DRIVER, endpoint)) { - /* Need to either suspend, or loop and call unlock/lock during - * every iteration - otherwise the system will remain locked, - * no interrupts served, so USB not going through as well. - * Note: for suspend, need USB_USE_WAIT == TRUE in halconf.h */ - if (osalThreadSuspendTimeoutS(&(&USB_DRIVER)->epc[endpoint]->in_state->thread, TIME_MS2I(10)) == MSG_TIMEOUT) { - osalSysUnlock(); - return; - } - } - usbStartTransmitI(&USB_DRIVER, endpoint, report, size); - osalSysUnlock(); +/** + * @brief Send a report to the host, but delay the sending until the size of + * endpoint report is reached or the incompletely filled buffer is flushed with + * a call to `flush_report_buffered`. This is useful if the report is being + * updated frequently. The complete report is then enqueued into an output + * queue and send once the USB endpoint becomes empty. + * + * @param endpoint USB IN endpoint to send the report from + * @param report pointer to the report + * @param size size of the report + * @return true Success + * @return false Failure + */ +static bool send_report_buffered(usb_endpoint_in_lut_t endpoint, void *report, size_t size) { + return usb_endpoint_in_send(&usb_endpoints_in[endpoint], (uint8_t *)report, size, TIME_MS2I(100), true); +} + +/** @brief Flush all buffered reports which were enqueued with a call to + * `send_report_buffered` that haven't been send. If necessary the buffered + * report can be padded with zeros up to the endpoints maximum size. + * + * @param endpoint USB IN endpoint to flush the reports from + * @param padded Pad the buffered report with zeros up to the endpoints maximum size + */ +static void flush_report_buffered(usb_endpoint_in_lut_t endpoint, bool padded) { + usb_endpoint_in_flush(&usb_endpoints_in[endpoint], padded); +} + +/** + * @brief Receive a report from the host. + * + * @param endpoint USB OUT endpoint to receive the report from + * @param report pointer to the report + * @param size size of the report + * @return true Success + * @return false Failure + */ +static bool receive_report(usb_endpoint_out_lut_t endpoint, void *report, size_t size) { + return usb_endpoint_out_receive(&usb_endpoints_out[endpoint], (uint8_t *)report, size, TIME_IMMEDIATE); } -/* prepare and start sending a report IN - * not callable from ISR or locked state */ void send_keyboard(report_keyboard_t *report) { /* If we're in Boot Protocol, don't send any report ID or other funky fields */ if (!keyboard_protocol) { - send_report(KEYBOARD_IN_EPNUM, &report->mods, 8); + send_report(USB_ENDPOINT_IN_KEYBOARD, &report->mods, 8); } else { - send_report(KEYBOARD_IN_EPNUM, report, KEYBOARD_REPORT_SIZE); + send_report(USB_ENDPOINT_IN_KEYBOARD, report, KEYBOARD_REPORT_SIZE); } - - keyboard_report_sent = *report; } void send_nkro(report_nkro_t *report) { #ifdef NKRO_ENABLE - send_report(SHARED_IN_EPNUM, report, sizeof(report_nkro_t)); + send_report(USB_ENDPOINT_IN_SHARED, report, sizeof(report_nkro_t)); #endif } @@ -889,8 +478,7 @@ void send_nkro(report_nkro_t *report) { void send_mouse(report_mouse_t *report) { #ifdef MOUSE_ENABLE - send_report(MOUSE_IN_EPNUM, report, sizeof(report_mouse_t)); - mouse_report_sent = *report; + send_report(USB_ENDPOINT_IN_MOUSE, report, sizeof(report_mouse_t)); #endif } @@ -901,25 +489,25 @@ void send_mouse(report_mouse_t *report) { void send_extra(report_extra_t *report) { #ifdef EXTRAKEY_ENABLE - send_report(SHARED_IN_EPNUM, report, sizeof(report_extra_t)); + send_report(USB_ENDPOINT_IN_SHARED, report, sizeof(report_extra_t)); #endif } void send_programmable_button(report_programmable_button_t *report) { #ifdef PROGRAMMABLE_BUTTON_ENABLE - send_report(SHARED_IN_EPNUM, report, sizeof(report_programmable_button_t)); + send_report(USB_ENDPOINT_IN_SHARED, report, sizeof(report_programmable_button_t)); #endif } void send_joystick(report_joystick_t *report) { #ifdef JOYSTICK_ENABLE - send_report(JOYSTICK_IN_EPNUM, report, sizeof(report_joystick_t)); + send_report(USB_ENDPOINT_IN_JOYSTICK, report, sizeof(report_joystick_t)); #endif } void send_digitizer(report_digitizer_t *report) { #ifdef DIGITIZER_ENABLE - send_report(DIGITIZER_IN_EPNUM, report, sizeof(report_digitizer_t)); + send_report(USB_ENDPOINT_IN_DIGITIZER, report, sizeof(report_digitizer_t)); #endif } @@ -931,46 +519,21 @@ void send_digitizer(report_digitizer_t *report) { #ifdef CONSOLE_ENABLE int8_t sendchar(uint8_t c) { - rbuf_enqueue(c); - return 0; + return (int8_t)send_report_buffered(USB_ENDPOINT_IN_CONSOLE, &c, sizeof(uint8_t)); } void console_task(void) { - if (!rbuf_has_data()) { - return; - } - - osalSysLock(); - if (usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) { - osalSysUnlock(); - return; - } - - if (usbGetTransmitStatusI(&USB_DRIVER, CONSOLE_IN_EPNUM)) { - osalSysUnlock(); - return; - } - - // Send in chunks - padded with zeros to 32 - char send_buf[CONSOLE_EPSIZE] = {0}; - uint8_t send_buf_count = 0; - while (rbuf_has_data() && send_buf_count < CONSOLE_EPSIZE) { - send_buf[send_buf_count++] = rbuf_dequeue(); - } - - usbStartTransmitI(&USB_DRIVER, CONSOLE_IN_EPNUM, (const uint8_t *)send_buf, CONSOLE_EPSIZE); - osalSysUnlock(); + flush_report_buffered(USB_ENDPOINT_IN_CONSOLE, true); } #endif /* CONSOLE_ENABLE */ #ifdef RAW_ENABLE void raw_hid_send(uint8_t *data, uint8_t length) { - // TODO: implement variable size packet if (length != RAW_EPSIZE) { return; } - chnWrite(&drivers.raw_driver.driver, data, length); + send_report(USB_ENDPOINT_IN_RAW, data, length); } __attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) { @@ -981,13 +544,9 @@ __attribute__((weak)) void raw_hid_receive(uint8_t *data, uint8_t length) { void raw_hid_task(void) { uint8_t buffer[RAW_EPSIZE]; - size_t size = 0; - do { - size = chnReadTimeout(&drivers.raw_driver.driver, buffer, sizeof(buffer), TIME_IMMEDIATE); - if (size > 0) { - raw_hid_receive(buffer, size); - } - } while (size > 0); + while (receive_report(USB_ENDPOINT_OUT_RAW, buffer, sizeof(buffer))) { + raw_hid_receive(buffer, sizeof(buffer)); + } } #endif @@ -995,32 +554,59 @@ void raw_hid_task(void) { #ifdef MIDI_ENABLE void send_midi_packet(MIDI_EventPacket_t *event) { - chnWrite(&drivers.midi_driver.driver, (uint8_t *)event, sizeof(MIDI_EventPacket_t)); + send_report(USB_ENDPOINT_IN_MIDI, (uint8_t *)event, sizeof(MIDI_EventPacket_t)); } bool recv_midi_packet(MIDI_EventPacket_t *const event) { - size_t size = chnReadTimeout(&drivers.midi_driver.driver, (uint8_t *)event, sizeof(MIDI_EventPacket_t), TIME_IMMEDIATE); - return size == sizeof(MIDI_EventPacket_t); + return receive_report(USB_ENDPOINT_OUT_MIDI, (uint8_t *)event, sizeof(MIDI_EventPacket_t)); } + void midi_ep_task(void) { uint8_t buffer[MIDI_STREAM_EPSIZE]; - size_t size = 0; - do { - size = chnReadTimeout(&drivers.midi_driver.driver, buffer, sizeof(buffer), TIME_IMMEDIATE); - if (size > 0) { - MIDI_EventPacket_t event; - recv_midi_packet(&event); - } - } while (size > 0); + while (receive_report(USB_ENDPOINT_OUT_MIDI, buffer, sizeof(buffer))) { + MIDI_EventPacket_t event; + // TODO: this seems totally wrong? The midi task will never see any + // packets if we consume them here + recv_midi_packet(&event); + } } #endif #ifdef VIRTSER_ENABLE +# include "hal_usb_cdc.h" +/** + * @brief CDC serial driver configuration structure. Set to 9600 baud, 1 stop bit, no parity, 8 data bits. + */ +static cdc_linecoding_t linecoding = {{0x00, 0x96, 0x00, 0x00}, LC_STOP_1, LC_PARITY_NONE, 8}; + +bool virtser_usb_request_cb(USBDriver *usbp) { + if ((usbp->setup[0] & USB_RTYPE_TYPE_MASK) == USB_RTYPE_TYPE_CLASS) { /* bmRequestType */ + if (usbp->setup[4] == CCI_INTERFACE) { /* wIndex (LSB) */ + switch (usbp->setup[1]) { /* bRequest */ + case CDC_GET_LINE_CODING: + usbSetupTransfer(usbp, (uint8_t *)&linecoding, sizeof(linecoding), NULL); + return true; + case CDC_SET_LINE_CODING: + usbSetupTransfer(usbp, (uint8_t *)&linecoding, sizeof(linecoding), NULL); + return true; + case CDC_SET_CONTROL_LINE_STATE: + /* Nothing to do, there are no control lines.*/ + usbSetupTransfer(usbp, NULL, 0, NULL); + return true; + default: + return false; + } + } + } + + return false; +} + void virtser_init(void) {} void virtser_send(const uint8_t byte) { - chnWrite(&drivers.serial_driver.driver, &byte, 1); + send_report_buffered(USB_ENDPOINT_IN_CDC_DATA, (void *)&byte, sizeof(byte)); } __attribute__((weak)) void virtser_recv(uint8_t c) { @@ -1028,14 +614,14 @@ __attribute__((weak)) void virtser_recv(uint8_t c) { } void virtser_task(void) { - uint8_t numBytesReceived = 0; - uint8_t buffer[16]; - do { - numBytesReceived = chnReadTimeout(&drivers.serial_driver.driver, buffer, sizeof(buffer), TIME_IMMEDIATE); - for (int i = 0; i < numBytesReceived; i++) { + uint8_t buffer[CDC_EPSIZE]; + while (receive_report(USB_ENDPOINT_OUT_CDC_DATA, buffer, sizeof(buffer))) { + for (int i = 0; i < sizeof(buffer); i++) { virtser_recv(buffer[i]); } - } while (numBytesReceived > 0); + } + + flush_report_buffered(USB_ENDPOINT_IN_CDC_DATA, false); } #endif |