Skip to content

Commit

Permalink
esp32c3_devkitm: doc: add espressif toolchain
Browse files Browse the repository at this point in the history
Instructions to build enviroment setup

Signed-off-by: Felipe Neves <ryukokki.felipe@gmail.com>
Signed-off-by: Felipe Neves <felipe.neves@espressif.com>
  • Loading branch information
uLipe authored and nashif committed Jul 8, 2021
1 parent 10c1395 commit b4a857d
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions boards/riscv/esp32c3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,40 @@ The features include the following:
System requirements
*******************


Build Environment Setup
=======================

Retrieve required submodules to build this port. This might take a while for the first time:
Some variables must be exported into the environment prior to building this port.
Find more information at :ref:`env_vars` on how to keep this settings saved in you environment.

.. note::

In case of manual toolchain installation, set :file:`ESPRESSIF_TOOLCHAIN_PATH` accordingly.
Otherwise, set toolchain path as below. If necessary.

On Linux and macOS:

.. code-block:: console
export ZEPHYR_TOOLCHAIN_VARIANT="espressif"
export ESPRESSIF_TOOLCHAIN_PATH="${HOME}/.espressif/tools/riscv32-esp-elf/1.24.0.123_64eb9ff-8.4.0/riscv32-esp-elf"
export PATH=$PATH:$ESPRESSIF_TOOLCHAIN_PATH/bin
On Windows:

.. code-block:: console
# on CMD:
set ESPRESSIF_TOOLCHAIN_PATH=%USERPROFILE%\.espressif\tools\riscv32-esp-elf\1.24.0.123_64eb9ff-8.4.0\riscv32-esp-elf
set ZEPHYR_TOOLCHAIN_VARIANT=espressif
set PATH=%PATH%;%ESPRESSIF_TOOLCHAIN_PATH%\bin
# on PowerShell
$env:ESPRESSIF_TOOLCHAIN_PATH="$env:USERPROFILE\.espressif\tools\riscv32-esp-elf\1.24.0.123_64eb9ff-8.4.0\riscv32-esp-elf"
$env:ZEPHYR_TOOLCHAIN_VARIANT="espressif"
$env:Path += "$env:ESPRESSIF_TOOLCHAIN_PATH\bin"
Finally, retrieve required submodules to build this port. This might take a while for the first time:

.. code-block:: console
Expand Down

0 comments on commit b4a857d

Please sign in to comment.