michaelh/zephyr
1
0
Fork 0
Code Releases Activity

boards/odroid_go: Update documentation

Browse source 
Update board's documentation.

Signed-off-by: Yannis Damigos <giannis.damigos@gmail.com>
This commit is contained in:
Yannis Damigos 2022-03-19 22:26:51 +02:00 • committed by Carles Cufí
commit 05c4f44112
1 changed files with 24 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

39
boards/xtensa/odroid_go/doc/index.rst
View file

@ -78,29 +78,41 @@ features:
Programming Programming
*********** ***********
Two components are required in order to build applications for this board: the The ESP32 toolchain :file:`xtensa-esp32-elf` is required to build this port.
`toolchain`_ and the `SDK`_. Both are provided by the SoC manufacturer. Install the toolchain:
The SDK contains headers and a hardware abstraction layer library (provided only .. code-block:: console
as object files) that are required for the port to function.
The toolchain is available for Linux, Windows, and macOS hosts and instructions west espressif install
to obtain and set them up are available in the `ESP-IDF repository
<https://github.com/espressif/esp-idf>`_, as explained in the .. note::
`ESP-IDF Programming Guide <SDK>`_.
By default, the toolchain will be downloaded and installed under $HOME/.espressif directory
(%USERPROFILE%/.espressif on Windows).
Set up build environment Set up build environment
------------------------ ------------------------
With both the toolchain and SDK installed, the Zephyr build system must be With the toolchain installed, the Zephyr build system must be instructed to
instructed to use this particular variant by setting the following shell use this particular variant by setting the following shell variables:
variables:
.. code-block:: console .. code-block:: console
export ZEPHYR_TOOLCHAIN_VARIANT="espressif" export ZEPHYR_TOOLCHAIN_VARIANT="espressif"
export ESPRESSIF_TOOLCHAIN_PATH="/path/to/xtensa-esp32-elf/" export ESPRESSIF_TOOLCHAIN_PATH="/path/to/xtensa-esp32-elf/"
Finally, retrieve required submodules to build this port. This might take
a while for the first time:
.. code-block:: console
west espressif update
.. note::
It is recommended running the command above after :file:`west update` so
that submodules also get updated.
Flashing Flashing
-------- --------
@ -112,7 +124,6 @@ Here is an example for the :ref:`hello_world` application.
:host-os: unix :host-os: unix
:board: odroid_go :board: odroid_go
:goals: build :goals: build
:gen-args: -DESP_IDF_PATH=/path/to/esp-idf/
Refer to :ref:`build_an_application` and :ref:`application_run` for more Refer to :ref:`build_an_application` and :ref:`application_run` for more
details. details.
@ -145,7 +156,7 @@ having build the application in the ``build`` directory:
.. code-block:: console .. code-block:: console
west flash -d build/ --skip-rebuild --esp-tool=/path/to/esp-idf/components/esptool_py/esptool/esptool.py --esp-device /dev/ttyUSB0 west flash -d build/ --skip-rebuild --esp-device /dev/ttyUSB0
Connect ODROID-GO to your PC via the mini USB port and run your favorite Connect ODROID-GO to your PC via the mini USB port and run your favorite
terminal program to listen for output. terminal program to listen for output.
@ -167,5 +178,3 @@ References
.. target-notes:: .. target-notes::
.. [1] https://wiki.odroid.com/odroid_go/odroid_go .. [1] https://wiki.odroid.com/odroid_go/odroid_go
.. _`toolchain`: https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html#get-started-setup-toolchain
.. _`SDK`: https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html#get-started-get-esp-idf