sergiotarxz/nuttx
sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

arch/risc-v/espressif: Add USB-Serial-JTAG driver

Browse Source 
Add support for USB-Serial-JTAG on ESP32-C3/C6/H2 using the Espressif HAL
This commit is contained in:
Lucas Saavedra Vaz 2023-06-21 10:38:10 -03:00 committed by Xiang Xiao
parent 4de2284614
commit 9bd1d5ddda
10 changed files with 687 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
arch/risc-v/src/espressif/Kconfig
View File

@ -224,6 +224,12 @@ config ESPRESSIF_UART1
select UART1_SERIALDRIVER
select ARCH_HAVE_SERIAL_TERMIOS
config ESPRESSIF_USBSERIAL
bool "USB-Serial-JTAG Driver"
default n
select OTHER_UART_SERIALDRIVER
select ARCH_HAVE_SERIAL_TERMIOS
config ESPRESSIF_GPIO_IRQ
bool "GPIO pin interrupts"
default n

4
arch/risc-v/src/espressif/Make.defs
View File

@ -68,6 +68,10 @@ ifeq ($(CONFIG_ESPRESSIF_HR_TIMER),y)
CHIP_CSRCS += esp_hr_timer.c
endif
ifeq ($(CONFIG_ESPRESSIF_USBSERIAL),y)
CHIP_CSRCS += esp_usbserial.c
endif
#############################################################################
# Espressif HAL for 3rd Party Platforms
#############################################################################

5
arch/risc-v/src/espressif/esp_config.h
View File

@ -63,4 +63,9 @@
# undef CONFIG_UART1_SERIAL_CONSOLE
#endif
#ifdef CONFIG_ESPRESSIF_USBSERIAL
# define HAVE_SERIAL_CONSOLE 1
# define HAVE_UART_DEVICE 1
#endif
#endif /* __ARCH_RISCV_SRC_ESPRESSIF_ESP_CONFIG_H */

5
arch/risc-v/src/espressif/esp_lowputc.c
View File

@ -43,6 +43,7 @@
#include "esp_gpio.h"
#include "esp_irq.h"
#include "esp_lowputc.h"
#include "esp_usbserial.h"
#include "hal/uart_hal.h"
#include "periph_ctrl.h"
@ -326,7 +327,7 @@ void riscv_lowputc(char ch)
struct esp_uart_s *priv = &g_uart0_config;
# elif defined (CONFIG_UART1_SERIAL_CONSOLE)
struct esp_uart_s *priv = &g_uart1_config;
#endif
# endif
/* Wait until the TX FIFO has space to insert new char */
@ -335,6 +336,8 @@ void riscv_lowputc(char ch)
/* Then send the character */
esp_lowputc_send_byte(priv, ch);
#elif defined(CONFIG_ESPRESSIF_USBSERIAL)
esp_usbserial_write(ch);
#endif /* CONSOLE_UART */
}

13
arch/risc-v/src/espressif/esp_serial.c
View File

@ -47,6 +47,10 @@
#include "esp_irq.h"
#include "esp_lowputc.h"
#ifdef CONFIG_ESPRESSIF_USBSERIAL
# include "esp_usbserial.h"
#endif
#include "esp_clk_tree.h"
#include "hal/uart_hal.h"
#include "soc/clk_tree_defs.h"
@ -94,6 +98,11 @@
# endif
#endif /* CONSOLE_UART */
#ifdef CONFIG_ESPRESSIF_USBSERIAL
# define CONSOLE_DEV g_uart_usbserial
# define TTYACM0_DEV g_uart_usbserial
#endif
/* Pick ttyS1 */
#if defined(CONFIG_ESPRESSIF_UART0) && !defined(UART0_ASSIGNED)
@ -1117,6 +1126,10 @@ void riscv_serialinit(void)
#ifdef TTYS1_DEV
uart_register("/dev/ttyS1", &TTYS1_DEV);
#endif
#ifdef CONFIG_ESPRESSIF_USBSERIAL
uart_register("/dev/ttyACM0", &TTYACM0_DEV);
#endif
}
/****************************************************************************

464
arch/risc-v/src/espressif/esp_usbserial.c Normal file
View File

@ -0,0 +1,464 @@
/****************************************************************************
* arch/risc-v/src/espressif/esp_usbserial.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdint.h>
#include <string.h>
#include <assert.h>
#include <debug.h>
#ifdef CONFIG_SERIAL_TERMIOS
# include <termios.h>
# include <nuttx/fs/ioctl.h>
#endif
#include <nuttx/arch.h>
#include <nuttx/irq.h>
#include <nuttx/kmalloc.h>
#include <nuttx/serial/serial.h>
#include <arch/irq.h>
#include "riscv_internal.h"
#include "esp_config.h"
#include "esp_irq.h"
#include "hal/uart_hal.h"
#include "hal/usb_serial_jtag_ll.h"
/****************************************************************************
* Pre-processor Macros
****************************************************************************/
/* The hardware buffer has a fixed size of 64 bytes */
#define ESP_USBCDC_BUFFERSIZE 64
/****************************************************************************
* Private Types
****************************************************************************/
struct esp_priv_s
{
const uint8_t source; /* Source ID */
const uint8_t irq; /* IRQ number assigned to the source */
int cpuint; /* CPU interrupt assigned */
};
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static int esp_interrupt(int irq, void *context, void *arg);
/* Serial driver methods */
static int esp_setup(struct uart_dev_s *dev);
static void esp_shutdown(struct uart_dev_s *dev);
static int esp_attach(struct uart_dev_s *dev);
static void esp_detach(struct uart_dev_s *dev);
static void esp_txint(struct uart_dev_s *dev, bool enable);
static void esp_rxint(struct uart_dev_s *dev, bool enable);
static bool esp_rxavailable(struct uart_dev_s *dev);
static bool esp_txready(struct uart_dev_s *dev);
static void esp_send(struct uart_dev_s *dev, int ch);
static int esp_receive(struct uart_dev_s *dev, unsigned int *status);
static int esp_ioctl(struct file *filep, int cmd, unsigned long arg);
/****************************************************************************
* Private Data
****************************************************************************/
static char g_rxbuffer[ESP_USBCDC_BUFFERSIZE];
static char g_txbuffer[ESP_USBCDC_BUFFERSIZE];
static struct esp_priv_s g_usbserial_priv =
{
.source = USB_SERIAL_JTAG_INTR_SOURCE,
.irq = ESP_IRQ_USB_SERIAL_JTAG,
.cpuint = -ENOMEM,
};
static struct uart_ops_s g_uart_ops =
{
.setup = esp_setup,
.shutdown = esp_shutdown,
.attach = esp_attach,
.detach = esp_detach,
.txint = esp_txint,
.rxint = esp_rxint,
.rxavailable = esp_rxavailable,
.txready = esp_txready,
.txempty = NULL,
.send = esp_send,
.receive = esp_receive,
.ioctl = esp_ioctl,
};
/****************************************************************************
* Public Data
****************************************************************************/
uart_dev_t g_uart_usbserial =
{
.isconsole = true,
.recv =
{
.size = ESP_USBCDC_BUFFERSIZE,
.buffer = g_rxbuffer,
},
.xmit =
{
.size = ESP_USBCDC_BUFFERSIZE,
.buffer = g_txbuffer,
},
.ops = &g_uart_ops,
.priv = &g_usbserial_priv,
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: esp_interrupt
*
* Description:
* This is the common UART interrupt handler. It will be invoked when an
* interrupt is received on the 'irq'. It should call uart_xmitchars or
* uart_recvchars to perform the appropriate data transfers. The
* interrupt handling logic must be able to map the 'arg' to the
* appropriate uart_dev_s structure in order to call these functions.
*
****************************************************************************/
static int esp_interrupt(int irq, void *context, void *arg)
{
struct uart_dev_s *dev = (struct uart_dev_s *)arg;
uint32_t tx_mask = USB_SERIAL_JTAG_SERIAL_IN_EMPTY_INT_ST;
uint32_t rx_mask = USB_SERIAL_JTAG_SERIAL_OUT_RECV_PKT_INT_ST;
uint32_t int_status = usb_serial_jtag_ll_get_intsts_mask();
/* Send buffer has room and can accept new data. */
if ((int_status & tx_mask) != 0)
{
usb_serial_jtag_ll_clr_intsts_mask(tx_mask);
uart_xmitchars(dev);
}
/* Data from the host are available to read. */
if ((int_status & rx_mask) != 0)
{
usb_serial_jtag_ll_clr_intsts_mask(rx_mask);
uart_recvchars(dev);
}
return OK;
}
/****************************************************************************
* Name: esp_setup
*
* Description:
* This method is called the first time that the serial port is opened.
*
****************************************************************************/
static int esp_setup(struct uart_dev_s *dev)
{
return OK;
}
/****************************************************************************
* Name: esp_shutdown
*
* Description:
* This method is called when the serial port is closed.
*
****************************************************************************/
static void esp_shutdown(struct uart_dev_s *dev)
{
}
/****************************************************************************
* Name: esp_txint
*
* Description:
* Call to enable or disable TX interrupts
*
****************************************************************************/
static void esp_txint(struct uart_dev_s *dev, bool enable)
{
if (enable)
{
usb_serial_jtag_ll_ena_intr_mask(
USB_SERIAL_JTAG_SERIAL_IN_EMPTY_INT_ENA);
}
else
{
usb_serial_jtag_ll_disable_intr_mask(
USB_SERIAL_JTAG_SERIAL_IN_EMPTY_INT_ENA);
}
}
/****************************************************************************
* Name: esp_rxint
*
* Description:
* Call to enable or disable RXRDY interrupts
*
****************************************************************************/
static void esp_rxint(struct uart_dev_s *dev, bool enable)
{
if (enable)
{
usb_serial_jtag_ll_ena_intr_mask(
USB_SERIAL_JTAG_SERIAL_OUT_RECV_PKT_INT_ENA);
}
else
{
usb_serial_jtag_ll_disable_intr_mask(
USB_SERIAL_JTAG_SERIAL_OUT_RECV_PKT_INT_ENA);
}
}
/****************************************************************************
* Name: esp_attach
*
* Description:
* Configure the UART to operation in interrupt driven mode. This method
* is called when the serial port is opened. Normally, this is just after
* the the setup() method is called, however, the serial console may
* operate in a non-interrupt driven mode during the boot phase.
*
* RX and TX interrupts are not enabled by the attach method (unless
* the hardware supports multiple levels of interrupt enabling). The RX
* and TX interrupts are not enabled until the txint() and rxint() methods
* are called.
*
****************************************************************************/
static int esp_attach(struct uart_dev_s *dev)
{
struct esp_priv_s *priv = dev->priv;
int ret;
DEBUGASSERT(priv->cpuint == -ENOMEM);
/* Try to attach the IRQ to a CPU int */
priv->cpuint = esp_setup_irq(priv->source,
ESP_IRQ_PRIORITY_DEFAULT,
ESP_IRQ_TRIGGER_LEVEL);
if (priv->cpuint < 0)
{
return priv->cpuint;
}
/* Attach and enable the IRQ */
ret = irq_attach(priv->irq, esp_interrupt, dev);
if (ret == OK)
{
up_enable_irq(priv->irq);
}
else
{
up_disable_irq(priv->irq);
}
return ret;
}
/****************************************************************************
* Name: esp_detach
*
* Description:
* Detach UART interrupts. This method is called when the serial port is
* closed normally just before the shutdown method is called. The
* exception is the serial console which is never shutdown.
*
****************************************************************************/
static void esp_detach(struct uart_dev_s *dev)
{
struct esp_priv_s *priv = dev->priv;
DEBUGASSERT(priv->cpuint != -ENOMEM);
up_disable_irq(priv->irq);
irq_detach(priv->irq);
esp_teardown_irq(priv->source, priv->cpuint);
priv->cpuint = -ENOMEM;
}
/****************************************************************************
* Name: esp_rxavailable
*
* Description:
* Return true if the receive holding register is not empty
*
****************************************************************************/
static bool esp_rxavailable(struct uart_dev_s *dev)
{
return (bool)usb_serial_jtag_ll_rxfifo_data_available();
}
/****************************************************************************
* Name: esp_txready
*
* Description:
* Return true if the transmit holding register is empty (TXRDY)
*
****************************************************************************/
static bool esp_txready(struct uart_dev_s *dev)
{
return (bool)usb_serial_jtag_ll_txfifo_writable();
}
/****************************************************************************
* Name: esp_send
*
* Description:
* This method will send one byte on the UART.
*
****************************************************************************/
static void esp_send(struct uart_dev_s *dev, int ch)
{
/* Write the character to the buffer. */
uint8_t buf[1] = {
(uint8_t)ch
};
usb_serial_jtag_ll_write_txfifo(buf, sizeof(buf));
/* Flush the character out. */
usb_serial_jtag_ll_txfifo_flush();
}
/****************************************************************************
* Name: esp32_receive
*
* Description:
* Called (usually) from the interrupt level to receive one character.
*
****************************************************************************/
static int esp_receive(struct uart_dev_s *dev, unsigned int *status)
{
uint8_t buf[1] = {
0
};
*status = 0;
usb_serial_jtag_ll_read_rxfifo(buf, sizeof(buf));
return (int)buf[0];
}
/****************************************************************************
* Name: esp_ioctl
*
* Description:
* All ioctl calls will be routed through this method
*
****************************************************************************/
static int esp_ioctl(struct file *filep, int cmd, unsigned long arg)
{
#if defined(CONFIG_SERIAL_TERMIOS)
struct inode *inode = filep->f_inode;
struct uart_dev_s *dev = inode->i_private;
#endif
int ret = OK;
switch (cmd)
{
#ifdef CONFIG_SERIAL_TERMIOS
case TCGETS:
{
struct termios *termiosp = (struct termios *)arg;
if (!termiosp)
{
ret = -EINVAL;
}
else
{
/* The USB Serial Console has fixed configuration of:
* 9600 baudrate, no parity, 8 bits, 1 stopbit.
*/
termiosp->c_cflag = CS8;
cfsetispeed(termiosp, 9600);
}
}
break;
case TCSETS:
ret = -ENOTTY;
break;
#endif /* CONFIG_SERIAL_TERMIOS */
default:
ret = -ENOTTY;
break;
}
return ret;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: esp_usbserial_write
*
* Description:
* Write one character through the USB serial. Used mainly for early
* debugging.
*
****************************************************************************/
void esp_usbserial_write(char ch)
{
while (!esp_txready(&g_uart_usbserial));
esp_send(&g_uart_usbserial, ch);
}

51
arch/risc-v/src/espressif/esp_usbserial.h Normal file
View File

@ -0,0 +1,51 @@
/****************************************************************************
* arch/risc-v/src/espressif/esp_usbserial.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __ARCH_RISCV_SRC_ESPRESSIF_ESP_USBSERIAL_H
#define __ARCH_RISCV_SRC_ESPRESSIF_ESP_USBSERIAL_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/serial/serial.h>
/****************************************************************************
* Public Data
****************************************************************************/
extern uart_dev_t g_uart_usbserial;
/****************************************************************************
* Public Functions Prototypes
****************************************************************************/
/****************************************************************************
* Name: esp_usbserial_write
*
* Description:
* Write one character through the USB serial. Used mainly for early
* debugging.
*
****************************************************************************/
void esp_usbserial_write(char ch);
#endif /* __ARCH_RISCV_SRC_ESPRESSIF_ESP_USBSERIAL_H */

46
boards/risc-v/espressif/esp32c3-generic/configs/usbconsole/defconfig Normal file
View File

@ -0,0 +1,46 @@
#
# This file is autogenerated: PLEASE DO NOT EDIT IT.
#
# You can use "make menuconfig" to make any modifications to the installed .config file.
# You can then do "make savedefconfig" to generate a new defconfig file that includes your
# modifications.
#
# CONFIG_ESPRESSIF_UART0 is not set
# CONFIG_NSH_ARGCAT is not set
# CONFIG_NSH_CMDOPT_HEXDUMP is not set
CONFIG_ARCH="risc-v"
CONFIG_ARCH_BOARD="esp32c3-generic"
CONFIG_ARCH_BOARD_COMMON=y
CONFIG_ARCH_BOARD_ESP32C3_GENERIC=y
CONFIG_ARCH_CHIP="espressif"
CONFIG_ARCH_CHIP_ESPRESSIF=y
CONFIG_ARCH_INTERRUPTSTACK=1536
CONFIG_ARCH_RISCV=y
CONFIG_ARCH_STACKDUMP=y
CONFIG_BOARDCTL_RESET=y
CONFIG_BOARD_LOOPSPERMSEC=15000
CONFIG_BUILTIN=y
CONFIG_DEV_ZERO=y
CONFIG_ESPRESSIF_USBSERIAL=y
CONFIG_EXAMPLES_HELLO=y
CONFIG_FS_PROCFS=y
CONFIG_IDLETHREAD_STACKSIZE=2048
CONFIG_INIT_ENTRYPOINT="nsh_main"
CONFIG_INTELHEX_BINARY=y
CONFIG_LIBC_PERROR_STDOUT=y
CONFIG_LIBC_STRERROR=y
CONFIG_NFILE_DESCRIPTORS_PER_BLOCK=6
CONFIG_NSH_ARCHINIT=y
CONFIG_NSH_BUILTIN_APPS=y
CONFIG_NSH_FILEIOSIZE=512
CONFIG_NSH_READLINE=y
CONFIG_NSH_STRERROR=y
CONFIG_PREALLOC_TIMERS=0
CONFIG_RR_INTERVAL=200
CONFIG_SCHED_BACKTRACE=y
CONFIG_SCHED_WAITPID=y
CONFIG_START_DAY=29
CONFIG_START_MONTH=11
CONFIG_START_YEAR=2019
CONFIG_SYSTEM_DUMPSTACK=y
CONFIG_SYSTEM_NSH=y

47
boards/risc-v/espressif/esp32c6-generic/configs/usbconsole/defconfig Normal file
View File

@ -0,0 +1,47 @@
#
# This file is autogenerated: PLEASE DO NOT EDIT IT.
#
# You can use "make menuconfig" to make any modifications to the installed .config file.
# You can then do "make savedefconfig" to generate a new defconfig file that includes your
# modifications.
#
# CONFIG_ESPRESSIF_UART0 is not set
# CONFIG_NSH_ARGCAT is not set
# CONFIG_NSH_CMDOPT_HEXDUMP is not set
CONFIG_ARCH="risc-v"
CONFIG_ARCH_BOARD="esp32c6-generic"
CONFIG_ARCH_BOARD_COMMON=y
CONFIG_ARCH_BOARD_ESP32C6_GENERIC=y
CONFIG_ARCH_CHIP="espressif"
CONFIG_ARCH_CHIP_ESPRESSIF=y
CONFIG_ARCH_INTERRUPTSTACK=2048
CONFIG_ARCH_RISCV=y
CONFIG_ARCH_STACKDUMP=y
CONFIG_BOARDCTL_RESET=y
CONFIG_BOARD_LOOPSPERMSEC=15000
CONFIG_BUILTIN=y
CONFIG_DEV_ZERO=y
CONFIG_ESPRESSIF_ESP32C6=y
CONFIG_ESPRESSIF_USBSERIAL=y
CONFIG_EXAMPLES_HELLO=y
CONFIG_FS_PROCFS=y
CONFIG_IDLETHREAD_STACKSIZE=2048
CONFIG_INIT_ENTRYPOINT="nsh_main"
CONFIG_INTELHEX_BINARY=y
CONFIG_LIBC_PERROR_STDOUT=y
CONFIG_LIBC_STRERROR=y
CONFIG_NFILE_DESCRIPTORS_PER_BLOCK=6
CONFIG_NSH_ARCHINIT=y
CONFIG_NSH_BUILTIN_APPS=y
CONFIG_NSH_FILEIOSIZE=512
CONFIG_NSH_READLINE=y
CONFIG_NSH_STRERROR=y
CONFIG_PREALLOC_TIMERS=0
CONFIG_RR_INTERVAL=200
CONFIG_SCHED_BACKTRACE=y
CONFIG_SCHED_WAITPID=y
CONFIG_START_DAY=29
CONFIG_START_MONTH=11
CONFIG_START_YEAR=2019
CONFIG_SYSTEM_DUMPSTACK=y
CONFIG_SYSTEM_NSH=y

47
boards/risc-v/espressif/esp32h2-generic/configs/usbconsole/defconfig Normal file
View File

@ -0,0 +1,47 @@
#
# This file is autogenerated: PLEASE DO NOT EDIT IT.
#
# You can use "make menuconfig" to make any modifications to the installed .config file.
# You can then do "make savedefconfig" to generate a new defconfig file that includes your
# modifications.
#
# CONFIG_ESPRESSIF_UART0 is not set
# CONFIG_NSH_ARGCAT is not set
# CONFIG_NSH_CMDOPT_HEXDUMP is not set
CONFIG_ARCH="risc-v"
CONFIG_ARCH_BOARD="esp32h2-generic"
CONFIG_ARCH_BOARD_COMMON=y
CONFIG_ARCH_BOARD_ESP32H2_GENERIC=y
CONFIG_ARCH_CHIP="espressif"
CONFIG_ARCH_CHIP_ESPRESSIF=y
CONFIG_ARCH_INTERRUPTSTACK=2048
CONFIG_ARCH_RISCV=y
CONFIG_ARCH_STACKDUMP=y
CONFIG_BOARDCTL_RESET=y
CONFIG_BOARD_LOOPSPERMSEC=15000
CONFIG_BUILTIN=y
CONFIG_DEV_ZERO=y
CONFIG_ESPRESSIF_ESP32H2=y
CONFIG_ESPRESSIF_USBSERIAL=y
CONFIG_EXAMPLES_HELLO=y
CONFIG_FS_PROCFS=y
CONFIG_IDLETHREAD_STACKSIZE=2048
CONFIG_INIT_ENTRYPOINT="nsh_main"
CONFIG_INTELHEX_BINARY=y
CONFIG_LIBC_PERROR_STDOUT=y
CONFIG_LIBC_STRERROR=y
CONFIG_NFILE_DESCRIPTORS_PER_BLOCK=6
CONFIG_NSH_ARCHINIT=y
CONFIG_NSH_BUILTIN_APPS=y
CONFIG_NSH_FILEIOSIZE=512
CONFIG_NSH_READLINE=y
CONFIG_NSH_STRERROR=y
CONFIG_PREALLOC_TIMERS=0
CONFIG_RR_INTERVAL=200
CONFIG_SCHED_BACKTRACE=y
CONFIG_SCHED_WAITPID=y
CONFIG_START_DAY=29
CONFIG_START_MONTH=11
CONFIG_START_YEAR=2019
CONFIG_SYSTEM_DUMPSTACK=y
CONFIG_SYSTEM_NSH=y