Skip to content

Commit

Permalink
boards: Add support for 01space esp32c3 0.42 oled
Browse files Browse the repository at this point in the history
From https://github.com/01Space/ESP32-C3-0.42LCD/

Adapted from the XIAO ESP32C3 board.

Signed-off-by: Jonathan Rico <[email protected]>
  • Loading branch information
jori-nordic authored and nashif committed Aug 7, 2024
1 parent 05c9773 commit 36c9fdc
Show file tree
Hide file tree
Showing 15 changed files with 436 additions and 0 deletions.
9 changes: 9 additions & 0 deletions boards/01space/esp32c3_042_oled/Kconfig.defconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Copyright 2022 Google LLC
# 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
5 changes: 5 additions & 0 deletions boards/01space/esp32c3_042_oled/Kconfig.esp32c3_042_oled
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Copyright 2024 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0

config BOARD_ESP32C3_042_OLED
select SOC_ESP32C3_FX4
10 changes: 10 additions & 0 deletions boards/01space/esp32c3_042_oled/Kconfig.sysbuild
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions boards/01space/esp32c3_042_oled/board.cmake
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 5 additions & 0 deletions boards/01space/esp32c3_042_oled/board.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
board:
name: esp32c3_042_oled
vendor: 01space
socs:
- name: esp32c3
Binary file not shown.
Binary file not shown.
172 changes: 172 additions & 0 deletions boards/01space/esp32c3_042_oled/doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
.. _01space_esp32c3_042_oled:

ESP32C3 0.42 OLED
#################

Overview
********

ESP32C3 0.42 OLED is a mini development board based on the `Espressif ESP32-C3`_
RISC-V WiFi/Bluetooth dual-mode chip.

For more details see the `01space ESP32C3 0.42 OLED`_ Github repo.

.. figure:: img/esp32c3_042_oled.webp
:align: center
:alt: 01space ESP32C3 0.42 OLED

01space ESP32C3 0.42 OLED

Hardware
********

This board is based on the ESP32-C3-FH4 with WiFi and BLE support.
It features:

* RISC-V SoC @ 160MHz with 4MB flash and 400kB RAM
* WS2812B RGB serial LED
* 0.42-inch OLED over I2C
* Qwiic I2C connector
* One pushbutton
* Onboard ceramic chip antenna
* On-chip USB-UART converter

.. note::

The RGB led is not supported on this Zephyr board yet.

.. note::

The ESP32-C3 does not have native USB, it has an on-chip USB-serial converter
instead.

Supported Features
==================

The 01space ESP32C3 0.42 OLED 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 |
+-----------+------------+------------------+
| RADIO | on-chip | Bluetooth |
+-----------+------------+------------------+
| DISPLAY | off-chip | display |
+-----------+------------+------------------+

Connections and IOs
===================

See the following image:

.. figure:: img/esp32c3_042_oled_pinout.webp
:align: center
:alt: 01space ESP32C3 0.42 OLED Pinout

01space ESP32C3 0.42 OLED Pinout

It also features a 0.42 inch OLED display, driven by a SSD1306-compatible chip.
It is connected over I2C: SDA on GPIO5, SCL on GPIO6.

Prerequisites
=============

Espressif HAL requires WiFi and Bluetooth binary blobs. 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`.

Programming and Debugging
*************************

Standalone application
======================

The board can be loaded using a single binary image, without 2nd stage bootloader.
It is the default option when building the application without additional configuration.

.. note::

This mode does not provide any security features nor OTA updates.

Use the following command to build a sample hello_world application:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: build

Sysbuild
========

:ref:`sysbuild` makes it possible to build and flash all necessary images needed to
bootstrap the board.

By default, the ESP32 sysbuild configuration creates bootloader (MCUboot) and
application images.

To build the sample application using sysbuild, use this command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:board: esp32c3_042_oled
:goals: build
:west-args: --sysbuild
:compact:

Flashing
========

For the :code:`Hello, world!` application, follow the instructions below.
Assuming the board is connected to ``/dev/ttyACM0`` on Linux.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32c3_042_oled
:goals: flash
:flash-args: --esp-device /dev/ttyACM0

Since the Zephyr console is by default on the ``usb_serial`` device, we use
the espressif monitor utility to connect to the console.

.. code-block:: console
$ west espressif monitor -p /dev/ttyACM0
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! esp32c3_042_oled
References
**********

.. target-notes::

.. _`Espressif ESP32-C3`: https://www.espressif.com/en/products/socs/esp32-c3
.. _`01space ESP32C3 0.42 OLED`: https://github.com/01Space/ESP32-C3-0.42LCD
43 changes: 43 additions & 0 deletions boards/01space/esp32c3_042_oled/esp32c3_042_oled-pinctrl.dtsi
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright 2022 Google LLC
*
* 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 {
uart1_default: uart1_default {
group1 {
pinmux = <UART1_TX_GPIO21>;
output-high;
};
group2 {
pinmux = <UART1_RX_GPIO20>;
bias-pull-up;
};
};

spim2_default: spim2_default {
group1 {
pinmux = <SPIM2_MISO_GPIO8>,
<SPIM2_SCLK_GPIO10>;
};
group2 {
pinmux = <SPIM2_MOSI_GPIO7>;
output-low;
};
};

i2c0_default: i2c0_default {
group1 {
pinmux = <I2C0_SDA_GPIO5>,
<I2C0_SCL_GPIO6>;
bias-pull-up;
drive-open-drain;
output-high;
};
};
};
Loading

0 comments on commit 36c9fdc

Please sign in to comment.