| .. _stamp_c3: |
| |
| M5Stack STAMP-C3 |
| ################## |
| |
| Overview |
| ******** |
| |
| STAMP-C3 featuring ESPRESSIF ESP32-C3 RISC-V MCU with Wi-Fi connectivity |
| for IoT edge devices such as home appliances and Industrial Automation. |
| |
| For more details see the `M5Stack STAMP-C3`_ page. |
| |
| Supported Features |
| ================== |
| |
| The STAMP-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 | |
| +-----------+------------+------------------+ |
| |
| |
| 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 |
| ******************* |
| |
| ESP-IDF bootloader |
| ================== |
| |
| The board is using the ESP-IDF bootloader as the default 2nd stage bootloader. |
| It is build as a subproject at each application build. No further attention |
| is expected from the user. |
| |
| 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 EPS32 SoC. |
| |
| To build the sample application using sysbuild use the command: |
| |
| .. zephyr-app-commands:: |
| :tool: west |
| :app: samples/hello_world |
| :board: stamp_c3 |
| :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: stamp_c3 |
| :goals: build |
| |
| The usual ``flash`` target will work with the ``stamp_c3`` board |
| configuration. Here is an example for the :ref:`hello_world` |
| application. |
| |
| .. zephyr-app-commands:: |
| :zephyr-app: samples/hello_world |
| :board: stamp_c3 |
| :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! stamp_c3 |
| |
| Debugging |
| ********* |
| |
| As with much custom hardware, the ESP32 modules require patches to |
| OpenOCD that are not upstreamed yet. Espressif maintains their own fork of |
| the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_ |
| |
| The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the |
| ``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>`` |
| parameter when building. |
| |
| Here is an example for building the :ref:`hello_world` application. |
| |
| .. zephyr-app-commands:: |
| :zephyr-app: samples/hello_world |
| :board: stamp_c3 |
| :goals: build flash |
| :gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts> |
| |
| 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: stamp_c3 |
| :goals: debug |
| |
| References |
| ********** |
| |
| .. target-notes:: |
| |
| .. _`M5Stack STAMP-C3`: https://docs.m5stack.com/en/core/stamp_c3 |
| .. _`ESP32C3 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf |
| .. _`ESP32C3 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf |
| .. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases |