diff --git a/ports/esp32/boards/ARDUINO_NANO_ESP32/mpconfigboard.cmake b/ports/esp32/boards/ARDUINO_NANO_ESP32/mpconfigboard.cmake index 40456f7c0b..d7db192ca4 100644 --- a/ports/esp32/boards/ARDUINO_NANO_ESP32/mpconfigboard.cmake +++ b/ports/esp32/boards/ARDUINO_NANO_ESP32/mpconfigboard.cmake @@ -18,7 +18,7 @@ set(SDKCONFIG_DEFAULTS set(MICROPY_SOURCE_BOARD ${MICROPY_BOARD_DIR}/board_init.c ${MICROPY_BOARD_DIR}/double_tap.c - ${MICROPY_DIR}/shared/tinyusb/mp_cdc_common.c + ${MICROPY_DIR}/shared/tinyusb/mp_usbd_cdc.c ) set(MICROPY_FROZEN_MANIFEST ${MICROPY_BOARD_DIR}/manifest.py) diff --git a/ports/nrf/Makefile b/ports/nrf/Makefile index 4fe921f0fa..1691719dbb 100644 --- a/ports/nrf/Makefile +++ b/ports/nrf/Makefile @@ -185,7 +185,7 @@ SRC_SHARED_C += $(addprefix shared/,\ runtime/pyexec.c \ runtime/sys_stdio_mphal.c \ runtime/interrupt_char.c \ - tinyusb/mp_cdc_common.c \ + tinyusb/mp_usbd_cdc.c \ timeutils/timeutils.c \ ) diff --git a/ports/renesas-ra/Makefile b/ports/renesas-ra/Makefile index b4b9733182..3a9abf7246 100644 --- a/ports/renesas-ra/Makefile +++ b/ports/renesas-ra/Makefile @@ -174,8 +174,8 @@ SHARED_SRC_C += $(addprefix shared/,\ runtime/stdout_helpers.c \ runtime/sys_stdio_mphal.c \ timeutils/timeutils.c \ - tinyusb/mp_cdc_common.c \ tinyusb/mp_usbd.c \ + tinyusb/mp_usbd_cdc.c \ tinyusb/mp_usbd_descriptor.c \ ) diff --git a/ports/rp2/CMakeLists.txt b/ports/rp2/CMakeLists.txt index fcc435b7b9..f86224a5c0 100644 --- a/ports/rp2/CMakeLists.txt +++ b/ports/rp2/CMakeLists.txt @@ -105,8 +105,8 @@ set(MICROPY_SOURCE_LIB ${MICROPY_DIR}/shared/runtime/softtimer.c ${MICROPY_DIR}/shared/runtime/sys_stdio_mphal.c ${MICROPY_DIR}/shared/timeutils/timeutils.c - ${MICROPY_DIR}/shared/tinyusb/mp_cdc_common.c ${MICROPY_DIR}/shared/tinyusb/mp_usbd.c + ${MICROPY_DIR}/shared/tinyusb/mp_usbd_cdc.c ${MICROPY_DIR}/shared/tinyusb/mp_usbd_descriptor.c ${MICROPY_DIR}/shared/tinyusb/mp_usbd_runtime.c ) diff --git a/ports/samd/Makefile b/ports/samd/Makefile index b678cd9828..487a9cb38b 100644 --- a/ports/samd/Makefile +++ b/ports/samd/Makefile @@ -133,8 +133,8 @@ SHARED_SRC_C += \ shared/runtime/stdout_helpers.c \ shared/runtime/sys_stdio_mphal.c \ shared/timeutils/timeutils.c \ - shared/tinyusb/mp_cdc_common.c \ shared/tinyusb/mp_usbd.c \ + shared/tinyusb/mp_usbd_cdc.c \ shared/tinyusb/mp_usbd_descriptor.c \ shared/tinyusb/mp_usbd_runtime.c \ diff --git a/shared/tinyusb/mp_usbd_cdc.c b/shared/tinyusb/mp_usbd_cdc.c new file mode 100644 index 0000000000..4135cd720f --- /dev/null +++ b/shared/tinyusb/mp_usbd_cdc.c @@ -0,0 +1,153 @@ +/* + * This file is part of the MicroPython project, http://micropython.org/ + * + * The MIT License (MIT) + * + * Copyright (c) 2022 Ibrahim Abdelkader + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include "py/runtime.h" +#include "py/mphal.h" +#include "py/mpconfig.h" +#include "py/stream.h" +#include "extmod/modmachine.h" + +#if MICROPY_HW_USB_CDC && MICROPY_HW_ENABLE_USBDEV +#include "tusb.h" +#include "device/usbd.h" + +#include "mp_usbd_cdc.h" +#include "mp_usbd.h" + +static uint8_t cdc_itf_pending; // keep track of cdc interfaces which need attention to poll + +uintptr_t mp_usbd_cdc_poll_interfaces(uintptr_t poll_flags) { + uintptr_t ret = 0; + if (!cdc_itf_pending) { + // Explicitly run the USB stack as the scheduler may be locked (eg we are in + // an interrupt handler) while there is data pending. + mp_usbd_task(); + } + + // any CDC interfaces left to poll? + if (cdc_itf_pending && ringbuf_free(&stdin_ringbuf)) { + for (uint8_t itf = 0; itf < 8; ++itf) { + if (cdc_itf_pending & (1 << itf)) { + tud_cdc_rx_cb(itf); + if (!cdc_itf_pending) { + break; + } + } + } + } + if ((poll_flags & MP_STREAM_POLL_RD) && ringbuf_peek(&stdin_ringbuf) != -1) { + ret |= MP_STREAM_POLL_RD; + } + if ((poll_flags & MP_STREAM_POLL_WR) && tud_cdc_connected() && tud_cdc_write_available() > 0) { + // When connected operate as blocking, only allow if space is available. + ret |= MP_STREAM_POLL_WR; + } + return ret; +} + +void tud_cdc_rx_cb(uint8_t itf) { + // consume pending USB data immediately to free usb buffer and keep the endpoint from stalling. + // in case the ringbuffer is full, mark the CDC interface that need attention later on for polling + cdc_itf_pending &= ~(1 << itf); + for (uint32_t bytes_avail = tud_cdc_n_available(itf); bytes_avail > 0; --bytes_avail) { + if (ringbuf_free(&stdin_ringbuf)) { + int data_char = tud_cdc_read_char(); + #if MICROPY_KBD_EXCEPTION + if (data_char == mp_interrupt_char) { + // Clear the ring buffer + stdin_ringbuf.iget = stdin_ringbuf.iput = 0; + // and stop + mp_sched_keyboard_interrupt(); + } else { + ringbuf_put(&stdin_ringbuf, data_char); + } + #else + ringbuf_put(&stdin_ringbuf, data_char); + #endif + } else { + cdc_itf_pending |= (1 << itf); + return; + } + } +} + +mp_uint_t mp_usbd_cdc_tx_strn(const char *str, mp_uint_t len) { + size_t i = 0; + if (tud_cdc_connected()) { + while (i < len) { + uint32_t n = len - i; + if (n > CFG_TUD_CDC_EP_BUFSIZE) { + n = CFG_TUD_CDC_EP_BUFSIZE; + } + int timeout = 0; + // Wait with a max of USC_CDC_TIMEOUT ms + while (n > tud_cdc_write_available() && timeout++ < MICROPY_HW_USB_CDC_TX_TIMEOUT) { + mp_event_wait_ms(1); + + // Explicitly run the USB stack as the scheduler may be locked (eg we + // are in an interrupt handler), while there is data pending. + mp_usbd_task(); + } + if (timeout >= MICROPY_HW_USB_CDC_TX_TIMEOUT) { + break; + } + uint32_t n2 = tud_cdc_write(str + i, n); + tud_cdc_write_flush(); + i += n2; + } + } + return i; +} + +#if MICROPY_HW_USB_CDC_1200BPS_TOUCH && MICROPY_HW_ENABLE_USBDEV + +static mp_sched_node_t mp_bootloader_sched_node; + +static void usbd_cdc_run_bootloader_task(mp_sched_node_t *node) { + mp_hal_delay_ms(250); + machine_bootloader(0, NULL); +} + +void +#if MICROPY_HW_USB_EXTERNAL_TINYUSB +mp_usbd_line_state_cb +#else +tud_cdc_line_state_cb +#endif + (uint8_t itf, bool dtr, bool rts) { + if (dtr == false && rts == false) { + // Device is disconnected. + cdc_line_coding_t line_coding; + tud_cdc_n_get_line_coding(itf, &line_coding); + if (line_coding.bit_rate == 1200) { + // Delay bootloader jump to allow the USB stack to service endpoints. + mp_sched_schedule_node(&mp_bootloader_sched_node, usbd_cdc_run_bootloader_task); + } + } +} + +#endif +#endif diff --git a/shared/tinyusb/mp_cdc_common.c b/shared/tinyusb/mp_usbd_cdc.h similarity index 55% rename from shared/tinyusb/mp_cdc_common.c rename to shared/tinyusb/mp_usbd_cdc.h index e790646f4f..f84cf8d03e 100644 --- a/shared/tinyusb/mp_cdc_common.c +++ b/shared/tinyusb/mp_usbd_cdc.h @@ -3,7 +3,7 @@ * * The MIT License (MIT) * - * Copyright (c) 2022 Ibrahim Abdelkader + * Copyright (c) 2022 Blake W. Felt & Angus Gratton * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -24,37 +24,16 @@ * THE SOFTWARE. */ -#include "py/runtime.h" -#include "py/mphal.h" -#include "extmod/modmachine.h" +#ifndef MICROPY_INCLUDED_SHARED_TINYUSB_MP_USBD_CDC_H +#define MICROPY_INCLUDED_SHARED_TINYUSB_MP_USBD_CDC_H -#if MICROPY_HW_USB_CDC_1200BPS_TOUCH && MICROPY_HW_ENABLE_USBDEV - -#include "tusb.h" +#ifndef MICROPY_HW_USB_CDC_TX_TIMEOUT +#define MICROPY_HW_USB_CDC_TX_TIMEOUT (500) +#endif -static mp_sched_node_t mp_bootloader_sched_node; +uintptr_t mp_usbd_cdc_poll_interfaces(uintptr_t poll_flags); +void tud_cdc_rx_cb(uint8_t itf); +mp_uint_t mp_usbd_cdc_tx_strn(const char *str, mp_uint_t len); -static void usbd_cdc_run_bootloader_task(mp_sched_node_t *node) { - mp_hal_delay_ms(250); - machine_bootloader(0, NULL); -} -void -#if MICROPY_HW_USB_EXTERNAL_TINYUSB -mp_usbd_line_state_cb -#else -tud_cdc_line_state_cb -#endif - (uint8_t itf, bool dtr, bool rts) { - if (dtr == false && rts == false) { - // Device is disconnected. - cdc_line_coding_t line_coding; - tud_cdc_n_get_line_coding(itf, &line_coding); - if (line_coding.bit_rate == 1200) { - // Delay bootloader jump to allow the USB stack to service endpoints. - mp_sched_schedule_node(&mp_bootloader_sched_node, usbd_cdc_run_bootloader_task); - } - } -} - -#endif +#endif // MICROPY_INCLUDED_SHARED_TINYUSB_MP_USBD_CDC_H