Skip to content

Commit

Permalink
boards: dptechnics: Add support for Walter board
Browse files Browse the repository at this point in the history
Add board definitions for the DPTechnics Walter board.

Signed-off-by: Thibo Verheyde <thibo@dptechnics.com>
  • Loading branch information
vThibo committed Jun 14, 2024
1 parent 08417b4 commit 4e3a2e1
Show file tree
Hide file tree
Showing 16 changed files with 732 additions and 0 deletions.
10 changes: 10 additions & 0 deletions boards/dptechnics/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _boards-dptechnics:

DPTechnics
##########

.. toctree::
:maxdepth: 1
:glob:

**/*
24 changes: 24 additions & 0 deletions boards/dptechnics/walter/Kconfig.defconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Copyright (c) 2024 DPTechnics bv
# SPDX-License-Identifier: Apache-2.0

if BOARD_WALTER_ESP32S3_PROCPU

config HEAP_MEM_POOL_ADD_SIZE_BOARD
int
default 65535 if WIFI && BT
default 51200 if WIFI
default 40960 if BT
default 4096

choice BT_HCI_BUS_TYPE
default BT_ESP32 if BT
endchoice

endif # BOARD_WALTER_ESP32S3_PROCPU

if BOARD_WALTER_ESP32S3_APPCPU

config HEAP_MEM_POOL_ADD_SIZE_BOARD
default 256

endif # BOARD_WALTER_ESP32S3_APPCPU
10 changes: 10 additions & 0 deletions boards/dptechnics/walter/Kconfig.sysbuild
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Copyright (c) 2024 DPTechnics bv
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
7 changes: 7 additions & 0 deletions boards/dptechnics/walter/Kconfig.walter
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Copyright (c) 2024 DPTechnics bv
# SPDX-License-Identifier: Apache-2.0

config BOARD_WALTER
select SOC_ESP32S3_WROOM_N16R2
select SOC_ESP32S3_PROCPU if BOARD_WALTER_ESP32S3_PROCPU
select SOC_ESP32S3_APPCPU if BOARD_WALTER_ESP32S3_APPCPU
9 changes: 9 additions & 0 deletions boards/dptechnics/walter/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/dptechnics/walter/board.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
board:
name: walter
vendor: dptechnics
socs:
- name: esp32s3
Binary file added boards/dptechnics/walter/doc/img/walter.webp
Binary file not shown.
284 changes: 284 additions & 0 deletions boards/dptechnics/walter/doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
.. _walter:

DPTechnics Walter
#################

Overview
********

Walter is a compact IoT development board that combines an Espressif ESP32-S3 SoC
with a Sequans Monarch 2 GM02SP LTE-M/NB-IoT/GNSS modem.

To help you get the most out of Walter, we have published the `schematic`_ and the
`KiCAD footprint`_, along with our `datasheet`_ which describes all pins and test pads.

.. figure:: img/walter.webp
:align: center
:alt: DPTechnics Walter board

DPTechnics Walter board (Credit: DPTechnics bv)

Hardware
********

ESP32-S3-WROOM-1-N16R2 microcontroller:

- Xtensa dual-core 32-bit LX7 CPU
- 16 MiB quad SPI flash memory
- 2 MiB quad SPI PSRAM
- 150 Mbps 802.11 b/g/n Wi-Fi 4 with on-board PCB antenna
- 2 Mbps Bluetooth 5 Low Energy with on-board PCB antenna

Sequans Monarch 2 GM02SP modem:

- Dual-mode LTE-M / NB-IoT (NB1, NB2)
- 3GPP LTE release 14 (Upgradable up to release 17)
- Ultra-low, deep-sleep mode in eDRX and PSM
- Adaptive +23 dBm, +20 dBm and +14 dBm output power
- Integrated LNA and SAW filter for GNSS reception
- Assisted and non-assisted GNSS with GPS and Galileo constellations
- Integrated SIM card
- Nano-SIM card slot
- u.FL RF connectors for GNSS and 5G antennas

Inputs & outputs:

- 24 GPIO pins for application use
- UART, SPI, I²C, CAN, I²S, and SD available on any of the GPIO pins
- ADC, DAC, and PWM integrated in ESP32-S3
- 3.3 V software-controllable output
- USB Type-C connector for flashing and debugging
- 22 test points for production programming and testing
- On-board reset button

Power supply

- 5.0 V via USB Type-C
- 3.0 - 5.5 V via Vin pin
- Not allowed to use both power inputs simultaneously
- Designed for extremely low quiescent current

Form factor

- Easy to integrate via 2.54 mm headers
- 55 mm x 24.8 mm board dimensions
- Pin and footprint compatible with EOL Pycom GPy
- Breadboard friendly

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

Current Zephyr's Walter board supports the following features:

+------------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+============+============+=====================================+
| UART | on-chip | serial port |
+------------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+------------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+------------+------------+-------------------------------------+
| USB-JTAG | on-chip | hardware interface |
+------------+------------+-------------------------------------+
| SPI Master | on-chip | spi |
+------------+------------+-------------------------------------+
| TWAI/CAN | on-chip | can |
+------------+------------+-------------------------------------+
| ADC | on-chip | adc |
+------------+------------+-------------------------------------+
| Timers | on-chip | counter |
+------------+------------+-------------------------------------+
| Watchdog | on-chip | watchdog |
+------------+------------+-------------------------------------+
| TRNG | on-chip | entropy |
+------------+------------+-------------------------------------+
| LEDC | on-chip | pwm |
+------------+------------+-------------------------------------+
| MCPWM | on-chip | pwm |
+------------+------------+-------------------------------------+
| PCNT | on-chip | qdec |
+------------+------------+-------------------------------------+
| GDMA | on-chip | dma |
+------------+------------+-------------------------------------+
| USB-CDC | on-chip | serial |
+------------+------------+-------------------------------------+
| RADIO | on-board | modem_cellular |
+------------+------------+-------------------------------------+

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-S3 SoC.

To build the sample application using sysbuild use the command:

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

By default, the ESP32 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: walter/esp32s3/procpu
:goals: build

The usual ``flash`` target will work with the ``walter`` board
configuration. Here is an example for the :ref:`hello_world`
application.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: walter/esp32s3/procpu
:goals: flash

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! walter/esp32s3/procpu
Debugging
*********

ESP32-S3 support on OpenOCD is available upstream as of version 0.12.0.
Download and install OpenOCD from `OpenOCD`_.

ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additional chip. Only an USB cable connected to the D+/D- pins is necessary.

Further documentation can be obtained from the SoC vendor in `JTAG debugging
for ESP32-S3`_.

Here is an example for building the :ref:`hello_world` application.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: walter/esp32s3/procpu
:goals: build flash

You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: walter/esp32s3/procpu
:goals: debug

.. _`JTAG debugging for ESP32-S3`:
https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/jtag-debugging/

.. _`OpenOCD`:
https://github.com/openocd-org/openocd

References
**********

.. target-notes::

.. _`schematic`:
https://github.com/QuickSpot/walter-hardware/tree/main/walter/schematic

.. _`KiCAD footprint`:
https://github.com/QuickSpot/walter-hardware/tree/main/walter/footprint

.. _`datasheet`:
https://www.quickspot.io/datasheet/walter_datasheet.pdf
7 changes: 7 additions & 0 deletions boards/dptechnics/walter/support/openocd.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
set ESP_RTOS none
set ESP32_ONLYCPU 1

# Source the JTAG interface configuration file
source [find interface/esp_usb_jtag.cfg]
# Source the ESP32-S3 configuration file
source [find target/esp32s3.cfg]
Loading

0 comments on commit 4e3a2e1

Please sign in to comment.