Gnu har example (#9)

* updated example har smartphone for GNU toolchain

* fixed link and cmd line

* updated README.md

* updated Makefile - renamed PUBLIC_DIR variable. added creation of a bin directory for external lib.

* updated README.md - Added some Notes for GNU part

* fixed link to specific paragraph

* added folder for prebuilt library, added README.md

* Update README.md

* Update README.md

* Update README.md

Author: dyudakov

build/rules.mk

@@ -1,3 +1,30 @@
+# Copyright (c) 2019, Synopsys, Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1) Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+# 
+# 2)  Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# 3) Neither the name of the <ORGANIZATION> nor the names of its contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 #=============================================================
 # OS-specific definitions
 #=============================================================
@@ -85,11 +112,13 @@ OBJS		= $(C_OBJS) $(CPP_OBJS) $(CC_OBJS) $(C_DEPNDS) $(CPP_DEPENDS) $(CC_DEPENDS
 #
 ifeq ($(TOOLCHAIN),gnu)
 # place to add GNU-specific common settings
-CFLAGS +=-fno-short-enums
+CFLAGS     +=-fno-short-enums
+DEPFLAGS    =
 else
 ifeq ($(TOOLCHAIN),mwdt)
 # place to add MWDT-specific common settings
-CFLAGS +=-Hon=Long_enums
+CFLAGS     +=-Hon=Long_enums
+DEPFLAGS    =-Hdepend=$(BUILD_DIR)/ -MD
 else
 $(error ERROR - Unsupported toolchain. Supported toolchains are 'gnu' and 'mwdt', default one is 'gnu')
 endif
@@ -132,7 +161,7 @@ else
  CFLAGS += -DRF_BUILD=0x006e
  CFLAGS += -DRF_BUILD=0x006e
  CFLAGS += -DSTATUS32=0x000a
- LDFLAGS += -marcv2elf
+ LDFLAGS += -marcv2elfx
  LDFLAGS += -lc
  LDFLAGS += -lm 
  LDFLAGS += -lnsim
@@ -160,21 +189,21 @@ ifeq ($(BUILD_DIR),)
 	$(error cannot build C object file $@ -- BUILD_DIR variable must be set)
 endif
 	@echo [CC] $<
-	$(CC) $(CFLAGS) $(INCS) -c -Hdepend=$(BUILD_DIR)/ -MD $< -o $@
+	$(CC) $(CFLAGS) $(INCS) -c $(DEPFLAGS) $< -o $@
 
 $(CPP_OBJS): $(BUILD_DIR)/%.o: %.cpp | $(BUILD_DIR)
 ifeq ($(BUILD_DIR),)
 	$(error cannot build C++ object file $@ -- BUILD_DIR variable must be set)
 endif
 	@echo [CPP] $<
-	$(CC) $(CFLAGS) $(INCS) -c -Hdepend=$(BUILD_DIR)/ -MD $< -o $@
+	$(CC) $(CFLAGS) $(INCS) -c $(DEPFLAGS) $< -o $@
 
 $(CC_OBJS): $(BUILD_DIR)/%.o: %.cc | $(BUILD_DIR)
 ifeq ($(BUILD_DIR),)
 	$(error cannot build C++ object file $@ -- BUILD_DIR variable must be set)
 endif
 	@echo [C++] $<
-	$(CC) $(CFLAGS) $(INCS) -c -Hdepend=$(BUILD_DIR)/ -MD $< -o $@
+	$(CC) $(CFLAGS) $(INCS) -c $(DEPFLAGS) $< -o $@
 
 $(LIBRARY_DIR):
 	$(MKDIR) $(call fix_platform_path, $(LIBRARY_DIR))
@@ -244,7 +273,7 @@ ELF_RUN=mdb $(MDB_ARGS) -nsim -tcf=$(TCF_FILE) -profile $(DBG_OPTS)
 endif
 
 ifeq ($(RUN_METHOD),NSIM_DEBUG)
-ELF_RUN=mdb -nsim -tcf=$(TCF_FILE)
+ELF_RUN=mdb -nsim -tcf=$(TCF_FILE) $(DBG_OPTS)
 endif
 
 ifeq ($(RUN_METHOD),XCAM_RUN)

examples/auxiliary/tests_aux.h

@@ -46,14 +46,13 @@ extern "C" {
 /** @def Macro for calculating number of fractionl bits. Uses container type and number of integer bits*/
 #define FRAQ_BITS(int_part, el_type) ((sizeof(el_type)*8)-int_part-1)
 
-
 #ifndef MAX
 /** @def Common Maximum macro function (two values)*/
-#define MAX(A,B) (((A > B)? A: B))
+#define MAX(A,B) (((A) > (B))? (A): (B))
 #endif
 /** @def Common Minimum macro function (two values)*/
 #ifndef MIN
-#define MIN(A,B) (((A > B)? B: A))
+#define MIN(A,B) (((A) > (B))? (B): (A))
 #endif
 
 #define CEIL_DIV(num,den) (((num) + (den) - 1)/(den))
@@ -81,9 +80,40 @@ extern unsigned cycle_cnt;
     cycle_cnt = _timer_default_read();
 #else
 //GNU toolchain profiling
+static inline void test_aux_start_timer_0() {
+    _sr(0 , 0x22);
+    _sr(0xffffffff, 0x23);
+    _sr(3, 0x22);
+    _sr(0, 0x21);
+}
+
+static inline uint32_t test_aux_read_timer_0() {
+    return (_lr(0x21));
+}
+
+static inline void test_aux_stop_timer_0() {
+    _sr (0 , 0x22);
+}
+
+static inline void test_aux_start_timer_1() {
+    _sr(0 , 0x101);
+    _sr(0xffffffff, 0x102);
+    _sr(3, 0x101);
+    _sr(0, 0x100);
+}
+
+static inline uint32_t test_aux_read_timer_1() {
+    return( _lr(0x100) );
+}
+
+static inline void test_aux_stop_timer_1() {
+    _sr (0 , 0x101);
+}
+
 #define PROFILE(F) \
-    cycle_cnt = 0;\
-    F;
+    test_aux_start_timer_0(); \
+    F;\
+    cycle_cnt = test_aux_read_timer_0();
 #endif
 #else
 #define PROFILE(F) \
@@ -147,7 +177,6 @@ test_status load_tensors_from_idx_files(
         mli_tensor * tensors[],
         uint32_t paths_num);
 
-
 /**
  * @brief Compare data in tensor with external reference data
  *

examples/example_har_smartphone/Makefile

@@ -27,33 +27,72 @@
 
 # default toolchain
 TOOLCHAIN ?= mwdt
-TCF_FILE ?= ../../hw/em9d.tcf
+
+# default hardware config file
+TCF_FILE  ?= ../../hw/em9d.tcf
 
 # Directories and files
-PUBLIC_DIR ?= ../..
-SRC_DIRS 	= $(PUBLIC_DIR)/examples/example_har_smartphone \
-			  $(PUBLIC_DIR)/examples/auxiliary
+EMBARC_MLI_DIR ?= ../..
+SRC_DIRS    = $(EMBARC_MLI_DIR)/examples/example_har_smartphone \
+              $(EMBARC_MLI_DIR)/examples/auxiliary
+
+INC_DIRS    = . \
+              $(EMBARC_MLI_DIR)/include\
+              $(EMBARC_MLI_DIR)/examples/auxiliary
+
+EXT_LIBS_DIR ?= $(EMBARC_MLI_DIR)/bin
+EXT_LIBS     ?= $(EXT_LIBS_DIR)/libmli.a
+OUT_DIR     ?= ./bin
+BUILD_DIR   ?= ./obj
+OUT_NAME    ?= example_har_smartphone
+ifeq ($(TOOLCHAIN),mwdt)
+# MWDT specific options
+CFLAGS       =  -Hnocopyr -Hpurge -Hheap=16K -Hstack=4K -Hfxapi -e_start -Bgrouplib -Hldopt=-q -O0
+else
+PREBUILT_LIB ?= $(EMBARC_MLI_DIR)/examples/prebuilt/libmli.a
+
+# GNU toolchain specific options - correct it according to your target platform settings (see build_configuration.txt for input)
+#Iot DevKit config
+CFLAGS       =  -mcpu=em4_dmips -mlittle-endian -mcode-density -mdiv-rem -mswap -mnorm -mmpy-option=6 -mbarrel-shifter -mxy
 
-INC_DIRS 	= . \
-			  $(PUBLIC_DIR)/include\
-			  $(PUBLIC_DIR)/examples/auxiliary
+# The embARC MLI Library specific options it according to your target platform settings 
+#(EM5D or EM7D platform)
+#CFLAGS      += -DV2DSP
+#(EM9D or EM11D platform)
+CFLAGS      += -DV2DSP_XY
+#(HS45D or HS47D platform)
+#CFLAGS      += -DV2DSP_WIDE
 
+# GNU toolchain linker specific options
+LDFLAGS      = --defsym=__DEFAULT_HEAP_SIZE=16k 
+LDFLAGS     += --defsym=__DEFAULT_STACK_SIZE=4k
+LDFLAGS     += -Map $(OUT_DIR)/$(OUT_NAME).map
 
-EXT_LIBS	?= $(PUBLIC_DIR)/bin/libmli.a
-OUT_DIR		?= ./bin
-BUILD_DIR	?= ./obj
-OUT_NAME	?= example_har_smartphone
-CFLAGS		=  -Hnocopyr -Hpurge -Hheap=16K -Hstack=4K -Hfxapi -e_start -Bgrouplib -Hldopt=-q -O0
+#specific options for run the example with the MetaWare Debuger on the nSim simulator. 
+DBG_OPTS     = -cmd="read mdb_com_gnu"
+endif
 
 all: lib app 
 
-include $(PUBLIC_DIR)/build/rules.mk
+$(EXT_LIBS): $(EXT_LIBS_DIR)
+	@echo Copy prebuilt library $(PREBUILT_LIB) to $@
+	@$(CP) $(call fix_platform_path,$(PREBUILT_LIB)) $(call fix_platform_path,$@)
+
+$(EXT_LIBS_DIR):
+	$(MKDIR) $(call fix_platform_path, $@))
+
+include $(EMBARC_MLI_DIR)/build/rules.mk
 
 .PHONY: clean all lib cleanall app
 .DEFAULT: all
 
+
+ifeq ($(TOOLCHAIN),mwdt)
 lib:
 	@ $(MAKE) generic_lib -C ..$(PS)..$(PS)lib$(PS)make$(PS) TCF_FILE="$(TCF_FILE)"
+else
+lib: $(EXT_LIBS)
+endif
 
 app: generic_app
 

examples/example_har_smartphone/README.md

@@ -10,9 +10,18 @@ Example shows how to work with recurrent primitives (LSTM and basic RNN) impleme
 
 Quick Start
 --------------
-Here we will consider building for hw/em9d.tcf template.
 
-0. embARC MLI Library must be built for required hardware configuration first. See [embARC MLI Library building and quick start](public/README.md).
+Example supports building using MetaWare Development tools and ARC GNU toolchain and running with MetaWare Debuger on nSim simulator.
+
+### Build with MetaWare Development tools
+
+    Build requirements:
+        - MetaWare Development tools version 2018.12 or higher
+        - gmake
+
+Here we will consider building for [/hw/em9d.tcf](/hw/em9d.tcf) template. This template is a default template for this example. Other templated can be also used. 
+
+0. embARC MLI Library must be built for required hardware configuration first. See [embARC MLI Library building and quick start](/README.md#building-and-quick-start).
 
 1. Open command line and change working directory to './examples/example_har_smartphone'
 
@@ -24,11 +33,54 @@ Here we will consider building for hw/em9d.tcf template.
 
        gmake TCF_FILE=../../hw/em9d.tcf 
 
-4. Run example 
+### Run example with MetaWare Debuger on nSim simulator.
 
        gmake run TCF_FILE=../../hw/em9d.tcf
 
-5. Result Quality shall be "S/N=1823.9     (65.2 db)"
+    Result Quality shall be "S/N=1823.9     (65.2 db)"
+
+### Build with ARC GNU toolchain
+
+Here we will consider building with ARC GNU toolchain. As a platform for the assembly, we use the [IoT Devkit](https://embarc.org/embarc_osp/doc/build/html/board/iotdk.html) from [the embARC Open Software Platform (OSP)](https://embarc.org/embarc_osp/doc/build/html/introduction/introduction.html#)
+
+    Build requirements:
+        - ARC GNU toolchain version 2018.09 or higher
+        - embARC MLI Library prebuilt with MetaWare Development tools for IoT Devkit hardware configuration
+        - gmake
+
+0. Prebuilt embARC MLI Library  must be copyied into the ./examples/prebuilt folder.
+
+1. Open command line and change working directory to './examples/example_har_smartphone'
+
+2. Clean previous build artifacts (optional)
+
+        gmake TOOLCHAIN=gnu clean
+
+3. Build example
+
+        gmake TOOLCHAIN=gnu
+
+   Notes: IoT Devkit hardware configuration is specifed in Makefile. Additionally used memory.x linkscript file for GNU linker. 
+
+### Run example with MetaWare Debuger on nSim simulator.
+
+    Run requirements:
+    - MetaWare Development tools version 2018.12 or higher
+    - arcem9d.tcf file with hardware configuration of IoT Devkit for setup nSim.
+
+0. Copy the [arcem9d.tcf](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/blob/master/board/iotdk/configs/10/tcf/arcem9d.tcf) file into example folder.
+
+1. Run example 
+
+        gmake run TOOLCHAIN=gnu TCF_FILE=arcem9d.tcf
+
+    Result Quality shall be "S/N=1823.9     (65.2 db)"
+
+    Notes: Example built by ARC GNU tools is run using mdb_com_gnu script file. Modify this file to customize the example run mode. See [More Options on Building and Running](README.md#more-options-on-building-and-running)
+
+### Run example without MetaWare Development tools
+
+See documentation on [IoT Devkit](https://embarc.org/embarc_osp/doc/build/html/board/iotdk.html) on how to run executable built with [ARC GNU](https://embarc.org/toolchain/index.html) and [ARC open source development tools](https://embarc.org/embarc_osp/doc/build/html/index.html) on IoT Devkit.
 
 
 Example Structure
@@ -48,8 +100,13 @@ Structure of example application may be divided logically on three parts:
    * ../auxiliary/tests_aux.h(.c)
    * ../auxiliary/idx_file.h(.c)
 
-Example structure also contains test vector set including small subset of pre-processed UCI HAR Smartphones dataset (20 vectors organized in IDX file format).
-   
+Example structure contains test vector set including small subset of pre-processed UCI HAR Smartphones dataset (20 vectors organized in IDX file format).
+
+Example structure also contains auxiliary files for development tools:
+ * arcem9d.lcf - linkscript file for MetaWare linker.
+ * memory.x    - linkscript file for GNU linker.
+ * mdb_com_gnu - command script file for MetaWare Debugger.
+
 More Options on Building and Running
 ---------------------------------------
 Coefficients for trained NN model are stored in the separate compile unit (*coefficients.c) as wrapped float numbers. This allows to transform coefficients into quantized fixed point values in compile time.
@@ -69,15 +126,18 @@ No application input arguments.
 
        gmake run TCF_FILE=../../hw/em9d.tcf
 
-2. **Accuracy measurement for testset.** Reads vectors from input IDX file, passes it to the model, and accumulates number of successive classifications according to labels IDX file. 
+2. **External test-set processing.** Reads vectors from input IDX file, passes it to the model, and writes it's output to the other IDX file (if input is *tests.idx* then output will be *tests.idx_out*). 
+Input test-set path is required as argument
+
+       gmake run TCF_FILE=../../hw/em9d.tcf RUN_ARGS="small_test_base/tests.idx"
+
+3. **Accuracy measurement for testset.** Reads vectors from input IDX file, passes it to the model, and accumulates number of successive classifications according to labels IDX file. 
 Input test-set and labels paths are required as argument.
 
        gmake run TCF_FILE=../../hw/em9d.tcf RUN_ARGS="small_test_base/tests.idx small_test_base/labels.idx"
 
-3. **External test-set processing.** Reads vectors from input IDX file, passes it to the model, and writes it's output to the other IDX file (if input is *tests.idx* then output will be *tests.idx_out*). 
-Input test-set path is required as argument
-
-       gmake run TCF_FILE=../../hw/em9d.tcf RUN_ARGS="small_test_base/tests.idx"
+Notes: If the example is compiled with GNU tools, then these modes are transferred to the application using mdb_com_gnu command script file for MetaWare Debugger.
+       Modify this file to customize the example run mode.
 
 References
 ----------------------------