boards: lilygo: ttgo_t8c3: initial support

adds initial support for Lilygo TTGO T8-C3 board

Signed-off-by: Lothar Felten <lothar.felten@gmail.com>

boards/lilygo/index.rst

@@ -0,0 +1,10 @@
+.. _boards-lilygo:
+
+Lilygo
+######
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   **/*

boards/lilygo/ttgo_t8c3/Kconfig.defconfig

@@ -0,0 +1,9 @@
+# Copyright (c) 2024 Lothar Felten <lothar.felten@gmail.com>
+# SPDX-License-Identifier: Apache-2.0
+
+config HEAP_MEM_POOL_ADD_SIZE_BOARD
+	int
+	default 65535 if WIFI && BT
+	default 51200 if WIFI
+	default 40960 if BT
+	default 4096

boards/lilygo/ttgo_t8c3/Kconfig.sysbuild

@@ -0,0 +1,10 @@
+# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
+# SPDX-License-Identifier: Apache-2.0
+
+choice BOOTLOADER
+	default BOOTLOADER_MCUBOOT
+endchoice
+
+choice BOOT_SIGNATURE_TYPE
+	default BOOT_SIGNATURE_TYPE_NONE
+endchoice

boards/lilygo/ttgo_t8c3/Kconfig.ttgo_t8c3

@@ -0,0 +1,5 @@
+# Copyright 2024 Lothar Felten <lothar.felten@gmail.com>
+# SPDX-License-Identifier: Apache-2.0
+
+config BOARD_TTGO_T8C3
+	select SOC_ESP32C3_FX4

boards/lilygo/ttgo_t8c3/board.cmake

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0
+
+if(NOT "${OPENOCD}" MATCHES "^${ESPRESSIF_TOOLCHAIN_PATH}/.*")
+  set(OPENOCD OPENOCD-NOTFOUND)
+endif()
+find_program(OPENOCD openocd PATHS ${ESPRESSIF_TOOLCHAIN_PATH}/openocd-esp32/bin NO_DEFAULT_PATH)
+
+include(${ZEPHYR_BASE}/boards/common/esp32.board.cmake)
+include(${ZEPHYR_BASE}/boards/common/openocd.board.cmake)

boards/lilygo/ttgo_t8c3/board.yml

@@ -0,0 +1,5 @@
+board:
+  name: ttgo_t8c3
+  vendor: lilygo
+  socs:
+  - name: esp32c3

boards/lilygo/ttgo_t8c3/doc/index.rst

@@ -0,0 +1,233 @@
+.. _ttgo_t8c3:
+
+Lilygo TTGO T8-C3
+#################
+
+Overview
+********
+
+Lilygo TTGO T8-C3 is an IoT mini development board based on the
+Espressif ESP32-C3 WiFi/Bluetooth dual-mode chip.
+
+It features the following integrated components:
+
+- ESP32-C3 chip (160MHz single core, 400KB SRAM, Wi-Fi)
+- on board antenna and IPEX connector
+- USB-C connector for power and communication
+- JST GH 2-pin battery connector
+- LED
+
+.. figure:: img/ttgo_t8c3.webp
+   :align: center
+   :alt: TTGO T8-C3
+
+   Lilygo TTGO T8-C3
+
+Functional Description
+**********************
+This board is based on the ESP32-C3 with 4MB of flash, WiFi and BLE support. It
+has an USB-C port for programming and debugging, integrated battery charging
+and an on-board antenna. The fitted U.FL external antenna connector can be
+enabled by moving a 0-ohm resistor.
+
+Connections and IOs
+===================
+
+The TTGO T8-C3 board configuration supports the following hardware features:
+
++-----------+------------+------------------+
+| Interface | Controller | Driver/Component |
++===========+============+==================+
+| PMP       | on-chip    | arch/riscv       |
++-----------+------------+------------------+
+| INTMTRX   | on-chip    | intc_esp32c3     |
++-----------+------------+------------------+
+| PINMUX    | on-chip    | pinctrl_esp32    |
++-----------+------------+------------------+
+| USB UART  | on-chip    | serial_esp32_usb |
++-----------+------------+------------------+
+| GPIO      | on-chip    | gpio_esp32       |
++-----------+------------+------------------+
+| UART      | on-chip    | uart_esp32       |
++-----------+------------+------------------+
+| I2C       | on-chip    | i2c_esp32        |
++-----------+------------+------------------+
+| SPI       | on-chip    | spi_esp32_spim   |
++-----------+------------+------------------+
+| TWAI      | on-chip    | can_esp32_twai   |
++-----------+------------+------------------+
+
+Start Application Development
+*****************************
+
+Before powering up your Lilygo TTGO T8-C3, please make sure that the board is in good
+condition with no obvious signs of damage.
+
+System requirements
+*******************
+
+Prerequisites
+=============
+
+Espressif HAL requires WiFi and Bluetooth binary blobs in order work. Run the command
+below to retrieve those files.
+
+.. code-block:: console
+
+   west blobs fetch hal_espressif
+
+.. note::
+
+   It is recommended running the command above after :file:`west update`.
+
+Building & Flashing
+*******************
+
+Simple boot
+===========
+
+The board could be loaded using the single binary image, without 2nd stage bootloader.
+It is the default option when building the application without additional configuration.
+
+.. note::
+
+   Simple boot does not provide any security features nor OTA updates.
+
+MCUboot bootloader
+==================
+
+User may choose to use MCUboot bootloader instead. In that case the bootloader
+must be build (and flash) at least once.
+
+There are two options to be used when building an application:
+
+1. Sysbuild
+2. Manual build
+
+.. note::
+
+   User can select the MCUboot bootloader by adding the following line
+   to the board default configuration file.
+   ```
+   CONFIG_BOOTLOADER_MCUBOOT=y
+   ```
+
+Sysbuild
+========
+
+The sysbuild makes possible to build and flash all necessary images needed to
+bootstrap the board with the ESP32-C3 SoC.
+
+To build the sample application using sysbuild use the command:
+
+.. zephyr-app-commands::
+   :tool: west
+   :app: samples/hello_world
+   :board: ttgo_t8c3
+   :goals: build
+   :west-args: --sysbuild
+   :compact:
+
+By default, the ESP32-C3 sysbuild creates bootloader (MCUboot) and application
+images. But it can be configured to create other kind of images.
+
+Build directory structure created by sysbuild is different from traditional
+Zephyr build. Output is structured by the domain subdirectories:
+
+.. code-block::
+
+  build/
+  ├── hello_world
+  │   └── zephyr
+  │       ├── zephyr.elf
+  │       └── zephyr.bin
+  ├── mcuboot
+  │    └── zephyr
+  │       ├── zephyr.elf
+  │       └── zephyr.bin
+  └── domains.yaml
+
+.. note::
+
+   With ``--sysbuild`` option the bootloader will be re-build and re-flash
+   every time the pristine build is used.
+
+For more information about the system build please read the :ref:`sysbuild` documentation.
+
+Manual build
+============
+
+During the development cycle, it is intended to build & flash as quickly possible.
+For that reason, images can be build one at a time using traditional build.
+
+The instructions following are relevant for both manual build and sysbuild.
+The only difference is the structure of the build directory.
+
+.. note::
+
+   Remember that bootloader (MCUboot) needs to be flash at least once.
+
+Build and flash applications as usual (see :ref:`build_an_application` and
+:ref:`application_run` for more details).
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/hello_world
+   :board: ttgo_t8c3
+   :goals: build
+
+The usual ``flash`` target will work with the ``ttgo_t8c3`` board
+configuration. Here is an example for the :ref:`hello_world`
+application.
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/hello_world
+   :board: ttgo_t8c3
+   :goals: flash
+
+The default baud rate for the Lilygo TTGO T8-C3 is set to 1500000bps. If experiencing issues when flashing,
+try using different values by using ``--esp-baud-rate <BAUD>`` option during
+``west flash`` (e.g. ``west flash --esp-baud-rate 115200``).
+
+You can also open the serial monitor using the following command:
+
+.. code-block:: shell
+
+   west espressif monitor
+
+After the board has automatically reset and booted, you should see the following
+message in the monitor:
+
+.. code-block:: console
+
+   ***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
+   Hello World! ttgo_t8c3
+
+Sample applications
+===================
+
+The following samples will run out of the box on the TTGO T8-C3 board.
+
+To build the blinky sample:
+
+.. zephyr-app-commands::
+   :tool: west
+   :app: samples/basic/blinky
+   :board: ttgo_t8c3
+   :goals: build
+
+To build the bluetooth beacon sample:
+
+.. zephyr-app-commands::
+   :tool: west
+   :app: samples/bluetooth/beacon
+   :board: ttgo_t8c3
+   :goals: build
+
+
+Related Documents
+*****************
+.. _`Lilygo TTGO T8-C3 schematic`: https://github.com/Xinyuan-LilyGO/T8-C3/blob/main/Schematic/T8-C3_V1.1.pdf
+.. _`Lilygo github repo`: https://github.com/Xinyuan-LilyGo
+.. _`Espressif ESP32-C3 datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
+.. _`Espressif ESP32-C3 technical reference manual`: https://www.espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf
+.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases

boards/lilygo/ttgo_t8c3/support/openocd.cfg

@@ -0,0 +1,6 @@
+set ESP_RTOS none
+
+source [find interface/esp_usb_jtag.cfg]
+
+source [find target/esp32c3.cfg]
+adapter_khz 5000

boards/lilygo/ttgo_t8c3/ttgo_t8c3-pinctrl.dtsi

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2024 Lothar Felten <lothar.felten@gmail.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/dt-bindings/pinctrl/esp-pinctrl-common.h>
+#include <dt-bindings/pinctrl/esp32c3-pinctrl.h>
+#include <zephyr/dt-bindings/pinctrl/esp32c3-gpio-sigmap.h>
+
+&pinctrl {
+	uart0_default: uart0_default {
+		group1 {
+			pinmux = <UART0_TX_GPIO21>;
+			output-high;
+		};
+		group2 {
+			pinmux = <UART0_RX_GPIO20>;
+			bias-pull-up;
+		};
+	};
+
+	spim2_default: spim2_default {
+		group1 {
+			pinmux = <SPIM2_MISO_GPIO5>,
+				 <SPIM2_SCLK_GPIO4>;
+		};
+		/* GPIO6 is CS */
+		group2 {
+			pinmux = <SPIM2_MOSI_GPIO7>;
+			output-low;
+		};
+	};
+
+	i2c0_default: i2c0_default {
+		group1 {
+			pinmux = <I2C0_SDA_GPIO2>,
+				 <I2C0_SCL_GPIO8>;
+			bias-pull-up;
+			drive-open-drain;
+			output-high;
+		};
+	};
+
+	twai_default: twai_default {
+		group1 {
+			pinmux = <TWAI_TX_GPIO0>,
+				 <TWAI_RX_GPIO10>;
+		};
+	};
+};

boards/lilygo/ttgo_t8c3/ttgo_t8c3.dts

@@ -0,0 +1,133 @@
+/*
+ * Copyright 2024 Lothar Felten <lothar.felten@gmail.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/dts-v1/;
+
+#include <espressif/esp32c3/esp32c3_common.dtsi>
+#include "ttgo_t8c3-pinctrl.dtsi"
+
+/ {
+	model = "Lilygo TTGO T8-C3";
+	compatible = "lilygo,ttgo-t8c3";
+
+	aliases {
+		led0 = &green_led;
+		i2c-0 = &i2c0;
+		watchdog0 = &wdt0;
+	};
+
+	chosen {
+		zephyr,sram = &sram0;
+		zephyr,console = &usb_serial;
+		zephyr,shell-uart = &usb_serial;
+		zephyr,flash = &flash0;
+		zephyr,code-partition = &slot0_partition;
+		zephyr,bt-hci = &esp32_bt_hci;
+		zephyr,canbus = &twai;
+	};
+
+	leds {
+		compatible = "gpio-leds";
+		green_led: led_0 {
+			gpios =  <&gpio0 3 GPIO_ACTIVE_HIGH>;
+			label = "Green - LED0";
+		};
+	};
+};
+
+&uart0 {
+	status = "okay";
+	current-speed = <115200>;
+	pinctrl-0 = <&uart0_default>;
+	pinctrl-names = "default";
+};
+
+&usb_serial {
+	status = "okay";
+};
+
+&i2c0 {
+	status = "okay";
+	clock-frequency = <I2C_BITRATE_STANDARD>;
+	pinctrl-0 = <&i2c0_default>;
+	pinctrl-names = "default";
+};
+
+&trng0 {
+	status = "okay";
+};
+
+&spi2 {
+	#address-cells = <1>;
+	#size-cells = <0>;
+	status = "okay";
+	pinctrl-0 = <&spim2_default>;
+	pinctrl-names = "default";
+};
+
+&gpio0 {
+	status = "okay";
+};
+
+&wdt0 {
+	status = "okay";
+};
+
+&timer0 {
+	status = "okay";
+};
+
+&timer1 {
+	status = "okay";
+};
+
+&twai {
+	status = "okay";
+	pinctrl-0 = <&twai_default>;
+	pinctrl-names = "default";
+};
+
+&wifi {
+	status = "okay";
+};
+
+&esp32_bt_hci{
+	status = "okay";
+};
+
+&flash0 {
+	partitions {
+		compatible = "fixed-partitions";
+		#address-cells = <1>;
+		#size-cells = <1>;
+
+		boot_partition: partition@0 {
+			label = "mcuboot";
+			reg = <0x00000000 0x0000F000>;
+			read-only;
+		};
+
+		slot0_partition: partition@10000 {
+			label = "image-0";
+			reg = <0x00010000 0x00100000>;
+		};
+
+		slot1_partition: partition@110000 {
+			label = "image-1";
+			reg = <0x00110000 0x00100000>;
+		};
+
+		scratch_partition: partition@210000 {
+			label = "image-scratch";
+			reg = <0x00210000 0x00040000>;
+		};
+
+		storage_partition: partition@250000 {
+			label = "storage";
+			reg = <0x00250000 0x00006000>;
+		};
+	};
+};

boards/lilygo/ttgo_t8c3/ttgo_t8c3.yaml

@@ -0,0 +1,18 @@
+identifier: ttgo_t8c3
+name: TTGO T8C3
+type: mcu
+arch: riscv
+toolchain:
+  - zephyr
+supported:
+  - gpio
+  - i2c
+  - spi
+  - uart
+  - watchdog
+  - can
+testing:
+  ignore_tags:
+    - net
+    - bluetooth
+vendor: lilygo

boards/lilygo/ttgo_t8c3/ttgo_t8c3_defconfig

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+
+CONFIG_MAIN_STACK_SIZE=2048
+
+CONFIG_CONSOLE=y
+CONFIG_SERIAL=y
+CONFIG_UART_CONSOLE=y
+CONFIG_GPIO=y

dts/bindings/vendor-prefixes.txt

@@ -368,6 +368,7 @@ lg	LG Corporation
 lgphilips	LG Display
 libretech	Shenzhen Libre Technology Co., Ltd
 licheepi	Lichee Pi
+lilygo	Lilygo Shenzhen Xinyuan Electronic Technology Co., Ltd
 linaro	Linaro Limited
 linksprite	LinkSprite Technologies, Inc.
 linksys	Belkin International, Inc. (Linksys)

tests/drivers/uart/uart_async_api/boards/ttgo_t8c3.conf

@@ -0,0 +1,2 @@
+CONFIG_HEAP_MEM_POOL_SIZE=32768
+CONFIG_DMA=y

tests/drivers/uart/uart_async_api/boards/ttgo_t8c3.overlay

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2022 Espressif Systems (Shanghai) Co., Ltd.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+&pinctrl {
+	uart1_test: uart1_test {
+		group1 {
+			pinmux = <UART1_TX_GPIO5>;
+			input-enable;
+		};
+		group2 {
+			pinmux = <UART1_RX_GPIO5>;
+			output-enable;
+		};
+	};
+};
+
+dut: &uart1 {
+	status = "okay";
+	current-speed = <115200>;
+	pinctrl-0 = <&uart1_test>;
+	pinctrl-names = "default";
+	dmas = <&dma 0>, <&dma 1>;
+	dma-names = "rx", "tx";
+};
+
+&dma {
+	status = "okay";
+};