From 8db03b41acbdcb05ff5028b33a0c16ef939e6443 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Fri, 4 Nov 2022 10:58:51 +0100 Subject: [PATCH 01/11] Code cleanup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- CMakeLists.txt | 2 +- uart-bridge.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index e0c286d..881c3f6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -7,7 +7,7 @@ include(pico-sdk/pico_sdk_init.cmake) project(pico_uart_bridge) pico_sdk_init() - + add_executable(uart_bridge uart-bridge.c usb-descriptors.c) target_include_directories(uart_bridge PUBLIC diff --git a/uart-bridge.c b/uart-bridge.c index 7ee6a9c..f716ba9 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -181,7 +181,7 @@ void core1_entry(void) int con = 0; tud_task(); - + for (itf = 0; itf < CFG_TUD_CDC; itf++) { if (tud_cdc_n_connected(itf)) { con = 1; From 3e1672f2c935284623b0058ad37f957e0dd08055 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Fri, 4 Nov 2022 10:59:54 +0100 Subject: [PATCH 02/11] Increase buffers and improve USB descriptors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- tusb_config.h | 4 ++-- uart-bridge.c | 2 +- usb-descriptors.c | 13 ++++++++----- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/tusb_config.h b/tusb_config.h index 6fcb7b9..80eeb52 100644 --- a/tusb_config.h +++ b/tusb_config.h @@ -13,8 +13,8 @@ #define CFG_TUSB_RHPORT0_MODE OPT_MODE_DEVICE #define CFG_TUD_CDC 2 -#define CFG_TUD_CDC_RX_BUFSIZE 256 -#define CFG_TUD_CDC_TX_BUFSIZE 256 +#define CFG_TUD_CDC_RX_BUFSIZE 1024 +#define CFG_TUD_CDC_TX_BUFSIZE 1024 void usbd_serial_init(void); diff --git a/uart-bridge.c b/uart-bridge.c index f716ba9..7a6ccab 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -17,7 +17,7 @@ #define LED_PIN 25 -#define BUFFER_SIZE 256 +#define BUFFER_SIZE 2560 #define DEF_BIT_RATE 115200 #define DEF_STOP_BITS 1 diff --git a/usb-descriptors.c b/usb-descriptors.c index 1ccd5de..738f9d0 100644 --- a/usb-descriptors.c +++ b/usb-descriptors.c @@ -18,18 +18,21 @@ #define USBD_PID 0x000A /* Raspberry Pi Pico SDK CDC */ #define USBD_DESC_LEN (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN * CFG_TUD_CDC) -#define USBD_MAX_POWER_MA 250 +#define USBD_MAX_POWER_MA 500 #define USBD_ITF_CDC_0 0 #define USBD_ITF_CDC_1 2 #define USBD_ITF_MAX 4 #define USBD_CDC_0_EP_CMD 0x81 -#define USBD_CDC_1_EP_CMD 0x84 -#define USBD_CDC_0_EP_OUT 0x02 -#define USBD_CDC_1_EP_OUT 0x05 +#define USBD_CDC_1_EP_CMD 0x83 + +#define USBD_CDC_0_EP_OUT 0x01 +#define USBD_CDC_1_EP_OUT 0x03 + #define USBD_CDC_0_EP_IN 0x82 -#define USBD_CDC_1_EP_IN 0x85 +#define USBD_CDC_1_EP_IN 0x84 + #define USBD_CDC_CMD_MAX_SIZE 8 #define USBD_CDC_IN_OUT_MAX_SIZE 64 From 01e7831501d24f09463751b0141dd44dcf4aa2c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Fri, 4 Nov 2022 11:00:31 +0100 Subject: [PATCH 03/11] uart-bridge: add UART RX interrupts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- uart-bridge.c | 75 ++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 54 insertions(+), 21 deletions(-) diff --git a/uart-bridge.c b/uart-bridge.c index 7a6ccab..407b676 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -26,6 +26,8 @@ typedef struct { uart_inst_t *const inst; + uint irq; + void *irq_fn; uint8_t tx_pin; uint8_t rx_pin; } uart_id_t; @@ -42,13 +44,20 @@ typedef struct { mutex_t usb_mtx; } uart_data_t; +void uart0_irq_fn(void); +void uart1_irq_fn(void); + const uart_id_t UART_ID[CFG_TUD_CDC] = { { .inst = uart0, + .irq = UART0_IRQ, + .irq_fn = &uart0_irq_fn, .tx_pin = 0, .rx_pin = 1, }, { .inst = uart1, + .irq = UART1_IRQ, + .irq_fn = &uart1_irq_fn, .tx_pin = 4, .rx_pin = 5, } @@ -119,14 +128,13 @@ void update_uart_cfg(uint8_t itf) mutex_exit(&ud->lc_mtx); } -void usb_read_bytes(uint8_t itf) { +void usb_read_bytes(uint8_t itf) +{ + uart_data_t *ud = &UART_DATA[itf]; uint32_t len = tud_cdc_n_available(itf); - if (len) { - uart_data_t *ud = &UART_DATA[itf]; - - mutex_enter_blocking(&ud->usb_mtx); - + if (len && + mutex_try_enter(&ud->usb_mtx, NULL)) { len = MIN(len, BUFFER_SIZE - ud->usb_pos); if (len) { uint32_t count; @@ -139,14 +147,14 @@ void usb_read_bytes(uint8_t itf) { } } -void usb_write_bytes(uint8_t itf) { +void usb_write_bytes(uint8_t itf) +{ uart_data_t *ud = &UART_DATA[itf]; - if (ud->uart_pos) { + if (ud->uart_pos && + mutex_try_enter(&ud->uart_mtx, NULL)) { uint32_t count; - mutex_enter_blocking(&ud->uart_mtx); - count = tud_cdc_n_write(itf, ud->uart_buffer, ud->uart_pos); if (count < ud->uart_pos) memcpy(ud->uart_buffer, &ud->uart_buffer[count], @@ -193,16 +201,16 @@ void core1_entry(void) } } -void uart_read_bytes(uint8_t itf) { +static inline void uart_read_bytes(uint8_t itf) +{ + uart_data_t *ud = &UART_DATA[itf]; const uart_id_t *ui = &UART_ID[itf]; if (uart_is_readable(ui->inst)) { - uart_data_t *ud = &UART_DATA[itf]; - mutex_enter_blocking(&ud->uart_mtx); while (uart_is_readable(ui->inst) && - ud->uart_pos < BUFFER_SIZE) { + (ud->uart_pos < BUFFER_SIZE)) { ud->uart_buffer[ud->uart_pos] = uart_getc(ui->inst); ud->uart_pos++; } @@ -211,22 +219,42 @@ void uart_read_bytes(uint8_t itf) { } } -void uart_write_bytes(uint8_t itf) { +void uart0_irq_fn(void) +{ + uart_read_bytes(0); +} + +void uart1_irq_fn(void) +{ + uart_read_bytes(1); +} + +void uart_write_bytes(uint8_t itf) +{ uart_data_t *ud = &UART_DATA[itf]; - if (ud->usb_pos) { + if (ud->usb_pos && + mutex_try_enter(&ud->usb_mtx, NULL)) { const uart_id_t *ui = &UART_ID[itf]; + uint32_t count = 0; - mutex_enter_blocking(&ud->usb_mtx); + while (uart_is_writable(ui->inst) && + count < ud->usb_pos) { + uart_putc(ui->inst, ud->usb_buffer[count]); + count++; + } - uart_write_blocking(ui->inst, ud->usb_buffer, ud->usb_pos); - ud->usb_pos = 0; + if (count < ud->usb_pos) + memcpy(ud->usb_buffer, &ud->usb_buffer[count], + ud->usb_pos - count); + ud->usb_pos -= count; mutex_exit(&ud->usb_mtx); } } -void init_uart_data(uint8_t itf) { +void init_uart_data(uint8_t itf) +{ const uart_id_t *ui = &UART_ID[itf]; uart_data_t *ud = &UART_DATA[itf]; @@ -261,6 +289,12 @@ void init_uart_data(uint8_t itf) { uart_set_format(ui->inst, databits_usb2uart(ud->usb_lc.data_bits), stopbits_usb2uart(ud->usb_lc.stop_bits), parity_usb2uart(ud->usb_lc.parity)); + uart_set_fifo_enabled(ui->inst, false); + + /* UART RX Interrupt */ + irq_set_exclusive_handler(ui->irq, ui->irq_fn); + irq_set_enabled(ui->irq, true); + uart_set_irq_enables(ui->inst, true, false); } int main(void) @@ -282,7 +316,6 @@ int main(void) while (1) { for (itf = 0; itf < CFG_TUD_CDC; itf++) { update_uart_cfg(itf); - uart_read_bytes(itf); uart_write_bytes(itf); } } From 3aa5d05fe3819d415ad5d97198fdeb00faab372d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Fri, 4 Nov 2022 11:08:49 +0100 Subject: [PATCH 04/11] Switch UART0 to GPIO 16 (TX) & GPIO 17 (RX) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- README.md | 4 ++-- uart-bridge.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c6a3967..8c5d87d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Raspberry Pi Pico Pinout | Raspberry Pi Pico GPIO | Function | |:----------------------:|:--------:| -| GPIO0 (Pin 1) | UART0 TX | -| GPIO1 (Pin 2) | UART0 RX | +| GPIO16 (Pin 21) | UART0 TX | +| GPIO17 (Pin 22) | UART0 RX | | GPIO4 (Pin 6) | UART1 TX | | GPIO5 (Pin 7) | UART1 RX | diff --git a/uart-bridge.c b/uart-bridge.c index 407b676..8564585 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -52,8 +52,8 @@ const uart_id_t UART_ID[CFG_TUD_CDC] = { .inst = uart0, .irq = UART0_IRQ, .irq_fn = &uart0_irq_fn, - .tx_pin = 0, - .rx_pin = 1, + .tx_pin = 16, + .rx_pin = 17, }, { .inst = uart1, .irq = UART1_IRQ, From 9d05ed4b1d36f5ea201051cbd1ae21d235dc9553 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Fri, 4 Nov 2022 11:13:57 +0100 Subject: [PATCH 05/11] uart-bridge: avoid CR/LF conversion MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- uart-bridge.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/uart-bridge.c b/uart-bridge.c index 8564585..e2aa518 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -240,7 +240,7 @@ void uart_write_bytes(uint8_t itf) while (uart_is_writable(ui->inst) && count < ud->usb_pos) { - uart_putc(ui->inst, ud->usb_buffer[count]); + uart_putc_raw(ui->inst, ud->usb_buffer[count]); count++; } From 67ce07178f1ebae63a319e3d19ab1084d64fe6e2 Mon Sep 17 00:00:00 2001 From: Michael Duda Date: Sun, 29 Jan 2023 11:49:11 -0700 Subject: [PATCH 06/11] Switch from memcpy to memmove when copying within buffers In the usb_write_bytes and uart_write_bytes routines, a memcpy was previously used to copy untransmitted bytes to the beginning of the buffer (ud->uart_buffer and ud->usb_buffer, respectively). Since the source and destination regions of memory may potentially overlap, the use of memcpy may lead to undefined results. From the draft C89 standard: 4.11.2.1 The memcpy function Synopsis #include void *memcpy(void *s1, const void *s2, size_t n); Description The memcpy function copies n characters from the object pointed to by s2 into the object pointed to by s1 . If copying takes place between objects that overlap, the behavior is undefined. Returns The memcpy function returns the value of s1 . By using memmove rather than memcpy in the usb_write_bytes and uart_write_bytes routines, the potential for undefined behavior can be avoided. --- uart-bridge.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/uart-bridge.c b/uart-bridge.c index e2aa518..9791df6 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -157,7 +157,7 @@ void usb_write_bytes(uint8_t itf) count = tud_cdc_n_write(itf, ud->uart_buffer, ud->uart_pos); if (count < ud->uart_pos) - memcpy(ud->uart_buffer, &ud->uart_buffer[count], + memmove(ud->uart_buffer, &ud->uart_buffer[count], ud->uart_pos - count); ud->uart_pos -= count; @@ -245,7 +245,7 @@ void uart_write_bytes(uint8_t itf) } if (count < ud->usb_pos) - memcpy(ud->usb_buffer, &ud->usb_buffer[count], + memmove(ud->usb_buffer, &ud->usb_buffer[count], ud->usb_pos - count); ud->usb_pos -= count; From 2e3f10f756e1b65adf8cf05129ea14dc0eb46a61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Wed, 10 Apr 2024 20:01:41 +0200 Subject: [PATCH 07/11] github: bump checkout to v4 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bad1152..4a20fa5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-20.04 steps: - name: 'Check out code' - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: 'Install dependencies' run: | From 2f05798e367f75270a55d781b9ec9d39b8a09740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Wed, 10 Apr 2024 20:02:38 +0200 Subject: [PATCH 08/11] github: bump upload-artifact to v4 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4a20fa5..0dfe717 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,7 +28,7 @@ jobs: make -C build - name: 'Upload binary' - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: pico-uart-bridge.uf2 path: build/uart_bridge.uf2 From b74af3b0d8aa27cb01193f1283394112809b2815 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Wed, 10 Apr 2024 19:54:05 +0200 Subject: [PATCH 09/11] uart-bridge: restore clock speed MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Apparently, some boards do not support setting a higher CPU clock: https://github.com/Noltari/pico-uart-bridge/issues/11#issuecomment-2048104347 Signed-off-by: Álvaro Fernández Rojas --- uart-bridge.c | 2 -- 1 file changed, 2 deletions(-) diff --git a/uart-bridge.c b/uart-bridge.c index 9791df6..c4e0805 100644 --- a/uart-bridge.c +++ b/uart-bridge.c @@ -301,8 +301,6 @@ int main(void) { int itf; - set_sys_clock_khz(250000, false); - usbd_serial_init(); for (itf = 0; itf < CFG_TUD_CDC; itf++) From c8a4bc513f0898e639421b10423d65e65cb81887 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Thu, 11 Apr 2024 19:11:33 +0200 Subject: [PATCH 10/11] pico-sdk: update to v1.5.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- pico-sdk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pico-sdk b/pico-sdk index 2e6142b..6a7db34 160000 --- a/pico-sdk +++ b/pico-sdk @@ -1 +1 @@ -Subproject commit 2e6142b15b8a75c1227dd3edbe839193b2bf9041 +Subproject commit 6a7db34ff63345a7badec79ebea3aaef1712f374 From 9d0df3277dcbbbcc9dd5e847205407560f512194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Fern=C3=A1ndez=20Rojas?= Date: Tue, 16 Apr 2024 12:22:25 +0200 Subject: [PATCH 11/11] github: ci: switch to ubuntu-22.04 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Álvaro Fernández Rojas --- .github/workflows/ci.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0dfe717..5478126 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,10 +1,12 @@ name: CI -on: [push, pull_request] +on: + - push + - pull_request jobs: CI: - runs-on: ubuntu-20.04 + runs-on: ubuntu-22.04 steps: - name: 'Check out code' uses: actions/checkout@v4