Minimize mbedos5 target (#4905)

* Removed hardware specific implementations
  * Added simple 'hello world' demo code to be aligned to other targets
  * Added ability to use external resources from outside JerryScript folder

JerryScript-DCO-1.0-Signed-off-by: Roland Takacs [email protected]

Author: rtakacs

.github/workflows/gh-actions.yml

@@ -255,7 +255,7 @@ jobs:
           python-version: '3.8' # needed due to 'intelhex' module
       - run: sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
       - run: sudo apt update
-      - run: sudo apt install gcc-arm-embedded python3-setuptools
+      - run: sudo apt install gcc-arm-embedded python3-setuptools mercurial
       - run: make -f ./targets/os/mbedos5/Makefile.travis install
       - run: make -f ./targets/os/mbedos5/Makefile.travis script
 

targets/os/mbedos5/.gitignore

@@ -1,9 +1 @@
-mbed-os
-mbed-events
-.build
 .mbed
-.temp/
-mbed_settings.py
-js/pins.js
-source/pins.cpp
-source/jerry-targetjs.h

targets/os/mbedos5/template-mbedignore.txt renamed to targets/os/mbedos5/.mbedignore

@@ -2,8 +2,7 @@ cmake/*
 docs/*
 jerry-main/*
 jerry-math/*
-jerry-port/default/default-date.c
-jerry-port/default/default-io.c
+jerry-port/*
 targets/*
 tests/*
 third-party/*

targets/os/mbedos5/Makefile

@@ -12,83 +12,46 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# USAGE:
-# specify the board using the command line:
-# make BOARD=[mbed board name]
+# default board: STM32F4-Discovery
+BOARD ?= DISCO_F407VG
 
-BOARD=$(subst [mbed] ,,$(shell mbed target))
-HEAPSIZE=16
+# defult toolchain
+TOOLCHAIN ?= GCC_ARM
 
-DEBUG?=0
-NO_JS?=0
-MBED_VERBOSE?=0
+# path to jerryscript/targets/os/mbedos5
+JERRY_TARGET_DIR = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
-MBED_CLI_FLAGS=-j0 --source . --source ../../../
+# path to the root jerryscript directory
+JERRY_ROOT_DIR = $(realpath $(JERRY_TARGET_DIR)/../../..)
 
-EXTRA_SRC=
+# default build path
+BUILD_DIR ?= $(JERRY_ROOT_DIR)/build/mbed-os
 
-ifneq ($(EXTRA_SRC),)
-EXTRA_SRC_MOD=--source $(subst :, --source ,$(EXTRA_SRC))
-MBED_CLI_FLAGS += $(EXTRA_SRC_MOD)
-endif
+# default jerry heap size (in KB)
+JERRY_HEAP_SIZE ?= 70
 
-EXTERN_BUILD_DIR=
-
-ifneq ($(EXTERN_BUILD_DIR),)
-MBED_CLI_FLAGS += --build $(EXTERN_BUILD_DIR)
-endif
-
-ifeq ($(DEBUG), 1)
-MBED_CLI_FLAGS += --profile ./mbed-os/tools/profiles/debug.json
-endif
-
-ifeq ($(MBED_VERBOSE), 1)
-MBED_CLI_FLAGS += -v
-else ifeq ($(MBED_VERBOSE), 2)
-MBED_CLI_FLAGS += -vv
-endif
-
-MBED_CLI_FLAGS += -D "JERRY_GLOBAL_HEAP_SIZE=$(HEAPSIZE)"
-MBED_CLI_FLAGS += -t GCC_ARM
-
-.PHONY: all js2c getlibs rebuild library
-all: source/jerry-targetjs.h source/pins.cpp .mbed ../../../.mbedignore
-	mbed target $(BOARD)
-	mbed compile $(MBED_CLI_FLAGS)
-
-library: .mbed ../../../.mbedignore
-	# delete encoded js code if it exists
-	rm -f source/jerry-targetjs.h
-	mbed target $(BOARD)
-	mbed compile $(MBED_CLI_FLAGS) --library
+.PHONY: all
+all: .mbedignore-copy .mbed-build .mbedignore-remove
 
+.PHONY: clean
 clean:
-	rm -rf ./BUILD/$(BOARD)
-
-js2c: js/main.js js/flash_leds.js
-	python ../../../tools/js2c.py --ignore pins.js
-
-source/pins.cpp:
-	python tools/generate_pins.py ${BOARD}
-
-ifeq ($(NO_JS),0)
-source/jerry-targetjs.h: js2c
-else
-source/jerry-targetjs.h: ;
-endif
-
-getlibs: .mbed
-
-.mbed:
-	echo 'ROOT=.' > .mbed
-	mbed config root .
-	mbed toolchain GCC_ARM
-	mbed target $(BOARD)
-	mbed deploy
-
-../../../.mbedignore:
-ifeq ($(OS),Windows_NT)
-	copy template-mbedignore.txt ..\..\..\.mbedignore
-else
-	cp ./template-mbedignore.txt ../../../.mbedignore
-endif
+	rm -rf $(JERRY_ROOT_DIR)/build/mbed-os
+
+.PHONY: .mbed-build
+.mbed-build:
+	mbed config -G MBED_OS_DIR $(MBED_OS_DIR)
+	mbed compile \
+		--clean \
+		--build $(BUILD_DIR) \
+		--source $(MBED_OS_DIR) \
+		--source $(JERRY_ROOT_DIR) \
+		--source $(JERRY_TARGET_DIR) \
+		--toolchain $(TOOLCHAIN) \
+		--target $(BOARD) \
+		--macro JERRY_GLOBAL_HEAP_SIZE=$(JERRY_HEAP_SIZE)
+
+.mbedignore-copy:
+	cp .mbedignore $(JERRY_ROOT_DIR)
+
+.mbedignore-remove:
+	rm $(JERRY_ROOT_DIR)/.mbedignore

targets/os/mbedos5/Makefile.travis

@@ -21,20 +21,18 @@ all:
 
 ## Targets for installing build dependencies of the Mbed OS 5 JerryScript target.
 
+install-mbedos:
+	git clone https://github.com/ARMmbed/mbed-os.git ../mbed-os -b mbed-os-5.15
+
 # Deploy Mbed and install Mbed Python dependencies.
-install:
+install-mbedos-deps:
 	pip install mbed-cli
-	cd targets/os/mbedos5 && mbed deploy
-	pip install idna==2.5 # FIXME: workaround
-	pip install -r targets/os/mbedos5/mbed-os/requirements.txt
-	pip install -r targets/os/mbedos5/tools/requirements.txt
+	pip install -r ../mbed-os/requirements.txt
 
+install: install-mbedos install-mbedos-deps
 
 ## Targets for building Mbed OS 5 with JerryScript.
 
 # Build the firmware (Mbed OS 5 with JerryScript).
 script:
-	# HACK: `EXTRA_SRC[_MOD]` are abused to pass `--library` to `mbed compile` in the `all` make target that builds an app
-	# HACK: this is needed because the Mbed OS 5 target code does not contain any `main` function, so the `all` make target does not link
-	# HACK: but the `library` make target does not build either because the launcher sources require `jerry-targetjs.h` that are explicitly not generated for libraries
-	$(MAKE) -C targets/os/mbedos5 BOARD=K64F EXTRA_SRC=dummy EXTRA_SRC_MOD=--library
+	$(MAKE) -C targets/os/mbedos5 BOARD=K64F MBED_OS_DIR=$(realpath ../mbed-os)

targets/os/mbedos5/README.md

@@ -1,74 +1,89 @@
-# JerryScript with mbed OS 5
+### About
 
-TL;DR? jump straight to [quickstart](#quick-start)
+This folder contains files to run JerryScript on
+[STM32F4-Discovery board](https://www.st.com/en/evaluation-tools/stm32f4discovery.html) with
+[Mbed OS 5](https://os.mbed.com/).
+The document had been validated on Ubuntu 20.04 operating system.
 
-## Introduction
+#### 1. Setup the build environment
 
-This directory contains the necessary code to build JerryScript for devices
-capable of running mbed OS 5. It has been tested with the following boards
-so far:
+Clone the necessary projects into a `jerry-mbedos` directory.
+The latest tested working version of Mbed is `5.15`.
 
-- [Nordic Semiconductor NRF52 Development Kit](https://developer.mbed.org/platforms/Nordic-nRF52-DK/)
-- [NXP Freedom K64F](https://developer.mbed.org/platforms/FRDM-K64F/)
-- [STM NUCLEO F401RE](https://developer.mbed.org/platforms/ST-Nucleo-F401RE/)
-- [Silicon Labs EFM32 Giant Gecko](https://developer.mbed.org/platforms/EFM32-Giant-Gecko/)
+```sh
+mkdir jerry-mbedos && cd jerry-mbedos
 
-## Features
+git clone https://github.com/jerryscript-project/jerryscript.git
+git clone https://github.com/ARMmbed/mbed-os.git -b mbed-os-5.15
+```
 
-### Peripheral Drivers
+The following directory structure has been created:
 
-Peripheral Drivers are intended as a 1-to-1 mapping to mbed C++ APIs, with a few
-differences (due to differences between JavaScript and C++ like lack of operator
-overloading).
+```
+jerry-mbedos
+  + jerryscript
+  |  + targets
+  |      + os
+  |        + mbedos5
+  + mbed-os
+```
 
-- [DigitalOut](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.1/APIs/io/DigitalOut/)
-- [InterruptIn](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.1/APIs/io/InterruptIn/)
-- [I2C](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.1/APIs/interfaces/digital/I2C/)
-- setInterval and setTimeout using [mbed-event](https://github.com/ARMmbed/mbed-events)
+#### 2. Install dependencies of the projects
 
-## Dependencies
+```sh
+# Assuming you are in jerry-mbedos folder.
+jerryscript/tools/apt-get-install-deps.sh
 
-### mbed CLI
+sudo apt install stlink-tools
+pip install mbed-cli
+# Install Python dependencies of Mbed OS.
+pip install --user -r mbed-os/requirements.txt
+```
 
-mbed CLI is used as the build tool for mbed OS 5. You can find out how to install
-it in the [official documentation](https://docs.mbed.com/docs/mbed-os-handbook/en/5.1/dev_tools/cli/#installing-mbed-cli).
+#### 4. Build Mbed OS (with JerryScript)
 
-### arm-none-eabi-gcc
+```
+# Assuming you are in jerry-mbedos folder.
+make -C jerryscript/targets/os/mbedos5 MBED_OS_DIR=${PWD}/mbed-os
+```
 
-arm-none-eabi-gcc is the only currently tested compiler for jerryscript on mbed,
-and instructions for building can be found as part of the mbed-cli installation
-instructions above.
+The created binary is a `mbed-os.bin` named file located in `jerryscript/build/mbed-os` folder.
 
-### make
+#### 5. Flash
 
-make is used to automate the process of fetching dependencies, and making sure that
-mbed-cli is called with the correct arguments.
+Connect Mini-USB for charging and flashing the device.
 
-### nodejs
+```
+# Assuming you are in jerry-riot folder.
+sudo st-flash write jerryscript/build/mbed-os/mbed-os.bin 0x8000000
+```
+
+#### 6. Connect to the device
 
-npm is used to install the dependencies in the local node_modules folder.
+Use `USB To TTL Serial Converter` for serial communication. STM32F4-Discovery pins are mapped by Mbed OS as follows:
 
-### gulp
+```
+  STM32f4-Discovery PA2 pin is configured for TX.
+  STM32f4-Discovery PA3 pin is configured for RX.
+```
 
-gulp is used to automate tasks, like cloning repositories or generate source files.
-If you create an own project, for more info see [mbed-js-gulp](https://github.com/ARMmbed/mbed-js-gulp).
+* 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`
 
-### (optional) jshint
+The device should be visible as `/dev/ttyUSB0`. Use `minicom` communication program with `115200`.
 
-jshint is used to statically check your JavaScript code, as part of the build process.
-This ensures that pins you are using in your code are available on your chosen target
-platform.
+* 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.
 
-## Quick Start
+```sh
+sudo minicom --device=/dev/ttyUSB0 --baud=115200
+```
 
-Once you have all of your dependencies installed, you can build the example project as follows:
+Press `RESET` on the board to get the output of JerryScript application:
 
-```bash
-git clone https://github.com/ARMmbed/mbed-js-example
-cd mbed-js-example
-npm install
-gulp --target=YOUR_TARGET_NAME
 ```
+This test run the following script code: [print ('Hello, World!');]
 
-The produced file (in build/out/YOUR_TARGET_NAME) can then be uploaded to your board, and will
-run when you press reset.
+Hello, World!
+```

targets/os/mbedos5/jerry-main.cpp

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+#include "mbed.h"
+
+#include "jerry-core/include/jerryscript.h"
+#include "jerry-core/include/jerryscript-port.h"
+#include "jerryscript-ext/handler.h"
+
+/**
+ * Standalone Jerry exit codes
+ */
+#define JERRY_STANDALONE_EXIT_CODE_OK   (0)
+#define JERRY_STANDALONE_EXIT_CODE_FAIL (1)
+
+/**
+ * Register a JavaScript function in the global object.
+ */
+static void
+register_js_function (const char *name_p, /**< name of the function */
+                      jerry_external_handler_t handler_p) /**< function callback */
+{
+  jerry_value_t result_val = jerryx_handler_register_global (name_p, handler_p);
+
+  if (jerry_value_is_exception (result_val))
+  {
+    jerry_port_log (JERRY_LOG_LEVEL_WARNING, "[Warning] Failed to register '%s' method.", name_p);
+  }
+
+  jerry_value_free (result_val);
+} /* register_js_function */
+
+int main()
+{
+  Serial device(USBTX, USBRX);  // tx, rx
+  device.baud(115200);
+
+  /* Initialize engine */
+  jerry_init (JERRY_INIT_EMPTY);
+
+  jerry_value_t ret_value = jerry_undefined ();
+  const jerry_char_t script[] = "print ('Hello, World!');";
+  jerry_port_log (JERRY_LOG_LEVEL_DEBUG, "This test run the following script code: [%s]\n\n", script);
+
+  /* Register the print function in the global object. */
+  register_js_function ("print", jerryx_handler_print);
+
+  /* Setup Global scope code */
+  ret_value = jerry_parse (script, sizeof (script) - 1, NULL);
+
+  if (!jerry_value_is_exception (ret_value))
+  {
+    /* Execute the parsed source code in the Global scope */
+    ret_value = jerry_run (ret_value);
+  }
+
+  int ret_code = JERRY_STANDALONE_EXIT_CODE_OK;
+
+  if (jerry_value_is_exception (ret_value))
+  {
+    jerry_port_log (JERRY_LOG_LEVEL_ERROR, "[Error] Script Error!");
+
+    ret_code = JERRY_STANDALONE_EXIT_CODE_FAIL;
+  }
+
+  jerry_value_free (ret_value);
+
+  /* Cleanup engine */
+  jerry_cleanup ();
+
+  return ret_code;
+}