Separate targets into os and baremetal-sdk parts (#4842)

JerryScript-DCO-1.0-Signed-off-by: Roland Takacs roland.takacs@h-lab.eu
2021-12-06 11:02:52 +01:00
parent 9860d66a56
commit af297bc578
110 changed files with 119 additions and 85 deletions
@@ -0,0 +1,117 @@
+### About
+
+This folder contains files to run JerryScript on
+[STM32F4-Discovery board](https://www.st.com/en/evaluation-tools/stm32f4discovery.html) with
+[RIOT](https://www.riot-os.org/).
+The document had been validated on Ubuntu 20.04 operating system.
+
+### How to build
+
+#### 1. Setup the build environment for STM32F4-Discovery board
+
+Clone the necessary projects into a `jerry-riot` directory.
+The latest tested working version of RIOT is `2021.10`.
+
+```sh
+# Create a base folder for all the projects.
+mkdir jerry-riot && cd jerry-riot
+
+git clone https://github.com/jerryscript-project/jerryscript.git
+git clone https://github.com/RIOT-OS/RIOT.git -b 2021.10
+```
+
+#### 2. Install dependencies of the projects
+
+```
+# Assuming you are in jerry-riot folder.
+jerryscript/tools/apt-get-install-deps.sh
+
+sudo apt install gcc-arm-none-eabi openocd minicom
+```
+
+The following directory structure has been created:
+
+```
+jerry-riot
+  + jerryscript
+  |  + targets
+  |      + os
+  |        + riot
+  + RIOT
+```
+
+#### 3. Build RIOT (with JerryScript)
+
+```
+# Assuming you are in jerry-riot folder.
+make BOARD=stm32f4discovery -f jerryscript/targets/os/riot/Makefile
+```
+
+The created binary is a `riot_jerryscript.elf` named file located in `jerryscript/build/riot-stm32f4/bin/` folder.
+
+#### 4. Flash the device
+
+Connect Mini-USB for charging and flashing the device.
+
+```
+# Assuming you are in jerry-riot folder.
+make BOARD=stm32f4discovery -f jerryscript/targets/os/riot/Makefile flash
+```
+
+Note: `ST-LINK` also can be used that is described at [this page](https://github.com/RIOT-OS/RIOT/wiki/ST-LINK-tool).
+
+#### 5. Connect to the device
+
+Use `USB To TTL Serial Converter` for serial communication. STM32F4-Discovery pins are mapped by RIOT as follows:
+
+```
+  STM32f4-Discovery PA2 pin is configured for TX.
+  STM32f4-Discovery PA3 pin is configured for RX.
+```
+
+* Connect `STM32f4-Discovery` **PA2** pin to **RX** pin of `USB To TTL Serial Converter`
+* Connect `STM32f4-Discovery` **PA3** pin to **TX** pin of `USB To TTL Serial Converter`
+* Connect `STM32f4-Discovery` **GND** pin to **GND** pin of `USB To TTL Serial Converter`
+
+The device should be visible as `/dev/ttyUSB0`. Use `minicom` communication program with `115200`.
+
+* In `minicom`, set `Add Carriage Ret` to `off` in by `CTRL-A -> Z -> U` key combinations.
+* In `minicom`, set `Hardware Flow Control` to `no` by `CTRL-A -> Z -> O -> Serial port setup -> F` key combinations.
+
+```sh
+sudo minicom --device=/dev/ttyUSB0 --baud=115200
+```
+
+RIOT prompt looks like as follows:
+
+```
+main(): This is RIOT! (Version: 2021.10)
+You are running RIOT on a(n) stm32f4discovery board.
+This board features a(n) stm32 MCU.
+>
+```
+
+You may have to press `RESET` on the board and press `Enter` key on the console several times to make RIOT prompt visible.
+
+#### 6. Run JerrySript
+
+Type `help` to list shell commands:
+
+```
+> help
+Command              Description
+---------------------------------------
+test                 Jerryscript Hello World test
+reboot               Reboot the node
+version              Prints current RIOT_VERSION
+pm                   interact with layered PM subsystem
+```
+
+Type `test` to execute JerryScript:
+
+```
+> test
+This test run the following script code: [print ('Hello, World!');]
+
+Hello, World!
+```