Merge esp8266-rtos-sdk and esp-idf targets (#4958)

This patch bumps esp8266-rtos-sdk to the latest release. This required to modify the directory structure and the build system to conform to ESP-IDF Style. Since esp-idf target already supports ESP-IDF Style, the espressif targets has been merged to eliminate code duplication. The target application code has been modified from blinking leds to hello world to be aligned to other targets. JerryScript-DCO-1.0-Signed-off-by: Roland Takacs roland.takacs@h-lab.eu
2022-02-22 10:58:18 +01:00
parent c9e9f8e818
commit 0d49696618
28 changed files with 495 additions and 1361 deletions
@@ -0,0 +1,52 @@
+# Copyright JS Foundation and other contributors, http://js.foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# Default target for running the build test outside the Travis CI environment.
+all:
+	$(MAKE) install
+	$(MAKE) script
+
+
+## Targets for installing build dependencies of the ESP8266 JerryScript target.
+
+# Install tools via apt.
+install-apt-get-deps:
+	sudo apt-get install -q -y wget
+
+# Fetch and extract Xtensa toolchain.
+install-xtensa-esp32-gcc:
+	wget https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_4_0-esp-2021r2-linux-amd64.tar.gz --no-check-certificate --directory-prefix /tmp
+	tar xvfz /tmp/xtensa-esp32-elf-gcc8_4_0-esp-2021r2-linux-amd64.tar.gz --directory /tmp
+
+# Fetch Espressif IoT Development Framework and install its dependencies.
+install-esp-idf:
+	git clone https://github.com/espressif/esp-idf.git /tmp/esp-idf -b release/v4.4
+	IDF_PATH=/tmp/esp-idf python -m pip install --user -r /tmp/esp-idf/requirements.txt
+
+# Perform all the necessary (JerryScript-independent) installation steps.
+install-noapt: install-xtensa-esp32-gcc install-esp-idf
+install: install-apt-get-deps install-noapt
+
+
+## Targets for building ESP-IDF with JerryScript.
+
+# Build the firmware (ESP-IDF with JerryScript).
+script:
+	PATH=/tmp/xtensa-esp32-elf/bin:$(PATH) \
+	python /tmp/esp-idf/tools/idf.py \
+		--project-dir ./targets/baremetal-sdk/espressif \
+		--build-dir ./build/esp-idf \
+		set-target esp32 \
+		all
@@ -0,0 +1,129 @@
+### About
+
+This folder contains files to run JerryScript on
+[ESP32 board](https://www.espressif.com/en/products/socs/esp32) with
+[ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/).
+The document had been validated on Ubuntu 20.04 operating system.
+
+### How to build
+
+#### 1. Setup the build environment
+
+Clone the necessary projects into a `jerry-esp` directory.
+The latest tested working version of ESP-IDF SDK is `release/v4.4`.
+
+```sh
+# Create a base folder for all the projects.
+mkdir jerry-esp && cd jerry-esp
+
+git clone https://github.com/jerryscript-project/jerryscript.git
+git clone https://github.com/espressif/esp-idf.git -b release/v4.4
+
+# SDK requires Xtensa toolchain.
+wget https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_4_0-esp-2021r2-linux-amd64.tar.gz
+```
+
+The following directory structure has been created:
+
+```
+jerry-esp
+  + jerryscript
+  |  + targets
+  |      + baremetal-sdk
+  |          + espressif
+  |
+  + esp-idf
+  + xtensa-esp32-elf-gcc8_4_0-esp-2021r2-linux-amd64.tar.gz
+```
+
+#### 2. Install dependencies of the projects
+
+```sh
+# Assuming you are in jerry-esp folder.
+jerryscript/tools/apt-get-install-deps.sh
+
+# Install dependencies of esp-idf.
+python -m pip install --user -r esp-idf/requirements.txt
+
+# Extract the downloaded toolchain.
+tar -xvf xtensa-esp32-elf-gcc8_4_0-esp-2021r2-linux-amd64.tar.gz
+```
+
+#### 3. Build ESP-IDF (with JerryScript)
+
+```sh
+# Assuming you are in jerry-esp folder.
+PATH=${PWD}/xtensa-esp32-elf/bin:$PATH esp-idf/tools/idf.py \
+  --project-dir jerryscript/targets/baremetal-sdk/espressif \
+  --build-dir jerryscript/build/esp-idf \
+  set-target esp32 \
+  all
+```
+
+The created binary is a `jerrycript.bin` named file located in `jerryscript/build/esp-idf` folder.
+
+#### 4. Flash the device
+
+Connect Micro-USB for charging and flashing the device. The device should be visible as /dev/ttyUSB0.
+
+```sh
+# Assuming you are in jerry-esp folder.
+sudo python esp-idf/components/esptool_py/esptool/esptool.py \
+  --chip esp32 \
+  --port /dev/ttyUSB0 \
+  --baud 460800 \
+  --before default_reset \
+  --after hard_reset \
+  write_flash \
+  --flash_mode dio \
+  --flash_size detect \
+  --flash_freq 40m \
+  0x1000 jerryscript/build/esp-idf/bootloader/bootloader.bin \
+  0x8000 jerryscript/build/esp-idf/partition_table/partition-table.bin \
+  0x10000 jerryscript/build/esp-idf/jerryscript.bin
+```
+
+#### 5. Connect to the device
+
+esp-idf provides a Python script for serial communication.
+Other programs also can be used such as minicom, picocom, etc.
+
+* The device should be visible as `/dev/ttyUSB0`
+* The device uses `115200` baud rate for serial communication
+* Press `CTRL` + `ALT` + `]` to exit monitor program
+
+```sh
+# Assuming you are in jerry-esp folder.
+PATH=${PWD}/xtensa-esp32-elf/bin:$PATH esp-idf/tools/idf_monitor.py \
+  --port /dev/ttyUSB0 \
+  --baud 115200 \
+  --toolchain-prefix=xtensa-esp32-elf- \
+  jerryscript/build/esp-idf/jerryscript.elf
+```
+
+The following output should be captured:
+
+```
+I (0) cpu_start: App cpu up.
+I (326) cpu_start: Pro cpu start user code
+I (326) cpu_start: cpu freq: 160000000
+I (326) cpu_start: Application information:
+I (331) cpu_start: Project name:     jerryscript
+I (336) cpu_start: App version:      v2.4.0-278-ge815e540-dirty
+I (342) cpu_start: Compile time:     Jan 21 2022 11:38:44
+I (349) cpu_start: ELF file SHA256:  2e874acb5a45c0cb...
+I (355) cpu_start: ESP-IDF:          v4.4-beta1-284-gd83021a6e8-dirt
+I (362) heap_init: Initializing. RAM available for dynamic allocation:
+I (369) heap_init: At 3FFAE6E0 len 00001920 (6 KiB): DRAM
+I (375) heap_init: At 3FFB8510 len 00027AF0 (158 KiB): DRAM
+I (381) heap_init: At 3FFE0440 len 00003AE0 (14 KiB): D/IRAM
+I (387) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM
+I (394) heap_init: At 4008B3E8 len 00014C18 (83 KiB): IRAM
+I (401) spi_flash: detected chip: generic
+I (405) spi_flash: flash io: dio
+I (410) cpu_start: Starting scheduler on PRO CPU.
+I (0) cpu_start: Starting scheduler on APP CPU.
+I (420) JS: This test run the following script code: 
+I (430) JS: print ('Hello, World!');
+Hello, World!
+```