MLECO-2682: CMake and source refactoring.

MLECO-2930: logging macros were extracted from hal.h and used separately around the code.

MLECO-2931: arm_math lib introduced, cmsis-dsp removed from top level linkage.

MLECO-2915: platform related post-build steps.

Change-Id: Id718884e22f262a5c070ded3f3f5d4b048820147
Signed-off-by: alexander <alexander.efremov@arm.com>

1 files changed, 58 insertions, 262 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2743066..5a7f1f2 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -14,9 +14,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #----------------------------------------------------------------------------
-# minimum version of cmake = 3.15 for legit reason:
-# armclang support doesn't work work in previous releases
-cmake_minimum_required(VERSION 3.15.0)
+cmake_minimum_required(VERSION 3.15.6)
+include(ExternalProject)
 
 # Build in release mode by default
 if (NOT CMAKE_BUILD_TYPE STREQUAL Debug)
@@ -25,8 +24,7 @@ endif()
 
 message(STATUS "Build type is set to ${CMAKE_BUILD_TYPE}")
 
-# Set language standards. TensorFlow Lite requires
-# std=c++11.
+# Set language standards.
 set(CMAKE_C_STANDARD   99)
 set(CMAKE_CXX_STANDARD 14)
 
@@ -39,11 +37,15 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
-set(CMAKE_SCRIPTS_DIR   ${CMAKE_CURRENT_SOURCE_DIR}/scripts/cmake)
+set(SCRIPTS_DIR         ${CMAKE_CURRENT_SOURCE_DIR}/scripts)
+set(CMAKE_SCRIPTS_DIR   ${SCRIPTS_DIR}/cmake)
+set(CMAKE_TOOLCHAIN_DIR ${CMAKE_SCRIPTS_DIR}/toolchains)
 set(DOWNLOAD_DEP_DIR    ${CMAKE_BINARY_DIR}/dependencies)
+set(DEPENDENCY_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/dependencies)
 
 set(RESOURCES_DIR       ${CMAKE_CURRENT_SOURCE_DIR}/resources_downloaded
                         CACHE PATH "Resources directory")
+set(HAL_PLATFORM_DIR    ${CMAKE_CURRENT_SOURCE_DIR}/source/hal/platform)
 
 include(${CMAKE_SCRIPTS_DIR}/source_gen_utils.cmake)
 
@@ -55,6 +57,11 @@ else()
 endif()
 
 include(${CMAKE_SCRIPTS_DIR}/common_user_options.cmake)
+include(${CMAKE_SCRIPTS_DIR}/platforms/${TARGET_PLATFORM}/build_configuration.cmake)
+
+set_platform_global_defaults()
+
+message(STATUS "Using CMAKE_TOOLCHAIN_FILE: ${CMAKE_TOOLCHAIN_FILE}")
 
 # Make sure the following options are defined before proceeding:
 assert_defined(LOG_LEVEL)
@@ -67,8 +74,9 @@ assert_defined(CPU_PROFILE_ENABLED)
 assert_defined(CMAKE_TOOLCHAIN_FILE)
 
 project(arm_ml_embedded_evaluation_kit
-        VERSION     21.11
-        DESCRIPTION "ARM ML Embedded Evaluation Kit for MPS3 FPGA and FastModel")
+        VERSION     21.11.1
+        DESCRIPTION "ARM ML Embedded Evaluation Kit"
+        LANGUAGES   C CXX ASM)
 
 enforce_compiler_version()
 setup_source_generator()
@@ -83,107 +91,30 @@ list(APPEND USE_CASES_TESTS_SEARCH_DIR_LIST ${TEST_SRCS}/use_case)
 if (CPU_PROFILE_ENABLED)
     set(PROFILING_OPT "${PROFILING_OPT} -DCPU_PROFILE_ENABLED")
 endif()
+# We include log target
+add_subdirectory(${SRC_PATH}/log ${CMAKE_BINARY_DIR}/log)
 
-# Include platform specific sources
-if (TARGET_PLATFORM STREQUAL native)
-    set(PLATFORM_SOURCES_CMAKE_FILE ${CMAKE_SCRIPTS_DIR}/${TARGET_PLATFORM}-sources.cmake)
-else ()
-    set(PLATFORM_SOURCES_CMAKE_FILE ${CMAKE_SCRIPTS_DIR}/bare-metal-sources.cmake)
-
-    assert_defined(CMSIS_SRC_PATH)
+# We include arm_math target
+add_subdirectory(${SRC_PATH}/math ${CMAKE_BINARY_DIR}/math)
 
-    if (CMAKE_BUILD_TYPE STREQUAL Debug AND CMAKE_CXX_COMPILER_ID STREQUAL ARMClang)
-        assert_defined(ARMCLANG_DEBUG_DWARF_LEVEL)
-    endif()
-endif ()
-
-message(STATUS "Including ${PLATFORM_SOURCES_CMAKE_FILE}")
-include(${PLATFORM_SOURCES_CMAKE_FILE})
-
-if (${CMAKE_CROSSCOMPILING})
-    enable_language(ASM)
-
-    # For non-native builds, we build with CMSIS-DSP support.
-    include(${CMAKE_SCRIPTS_DIR}/cmsis-dsp.cmake)
-
-    # All CMSIS headers to be used:
-    set(CMSIS_HEADERS
-        ${CMSIS_DSP_INC_DIR}
-        ${CMSIS_CORE_INC_DIR}
-        ${CMSIS_SRC_PATH}/Device/ARM/${ARM_CPU}/Include
-        ${CMSIS_SRC_PATH}/Device/ARM/${ARM_CPU}/Include/Template)
-endif ()
-
-# If we need NPU libraries:
-if (ETHOS_U_NPU_ENABLED)
-
-    message(STATUS "Using ARM Ethos-U NPU - adding core-driver and timing-adapter-driver includes and libraries")
-
-    assert_defined(ETHOS_U_NPU_TIMING_ADAPTER_SRC_PATH)
-    assert_defined(ETHOS_U_NPU_DRIVER_SRC_PATH)
-
-    include_directories("${ETHOS_U_NPU_TIMING_ADAPTER_SRC_PATH}/include/")
-
-    add_subdirectory("${ETHOS_U_NPU_TIMING_ADAPTER_SRC_PATH}" ${CMAKE_BINARY_DIR}/timing-adapter)
-
-    set(ETHOSU_INCLUDES ${ETHOS_U_NPU_TIMING_ADAPTER_SRC_PATH}/include
-                        ${ETHOS_U_NPU_DRIVER_SRC_PATH}/include)
-
-    list(APPEND ETHOS_U_NPU_LIBS ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libtiming_adapter.a)
-endif ()
+# We include the hal target
+add_subdirectory(${SRC_PATH}/hal ${CMAKE_BINARY_DIR}/hal)
 
+# Include the tensorflow build target
 include(${CMAKE_SCRIPTS_DIR}/tensorflow.cmake)
 
-set(DEP_TENSORFLOW_LITE_MICRO_SUB_DIR ${TENSORFLOW_SRC_PATH}/tensorflow/lite/micro)
-set(DEP_TENSORFLOW_LITE_MICRO_MAKE_DIR ${DEP_TENSORFLOW_LITE_MICRO_SUB_DIR}/tools/make/targets)
-set(DEP_FLATBUF_INCLUDE ${DEP_TENSORFLOW_LITE_MICRO_SUB_DIR}/tools/make/downloads/flatbuffers/include)
-
-set(TENSORFLOW_LIBRARY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/${TENSORFLOW_LITE_MICRO_PLATFORM_LIB_NAME})
-
-set(DEP_TF_INCLUDE_DIRS
-    ${TENSORFLOW_SRC_PATH}
-    ${DEP_TENSORFLOW_LITE_MICRO_SUB_DIR}
-    ${ETHOSU_INCLUDES}
-    ${CMSIS_HEADERS}
-    )
-
-## All TPIP includes
-set(DEP_RUNTIME_INCLUDE_DIRS
-    ${DEP_TF_INCLUDE_DIRS}
-    ${DEP_FLATBUF_INCLUDE}
-    )
-
-# Our entry point into tensorflow world:
-file(GLOB_RECURSE SRC_TENSORFLOW_LITE_MICRO
-    ${SRC_PATH}/application/tensorflow-lite-micro/**/*.cc
-    ${SRC_PATH}/application/tensorflow-lite-micro/*.cc
-    )
-
-set(HAL_DIR ${SRC_PATH}/application/hal)
-
-# HAL API sources
-file(GLOB_RECURSE SRC_HAL
-    "${HAL_DIR}/hal.c"
-    )
-
-# Set platform specific HAL sources; these should be provided
-# by each platform's cmake include file
-list(APPEND SRC_HAL ${SRC_PLAT_HAL})
-
 # Profiler
 if (NOT DEFINED PROFILER_DIR)
     set(PROFILER_DIR ${SRC_PATH}/application/profiler)
 endif ()
 
-# Include directories:
-list(APPEND APPLICATION_INCLUDE_DIRS
-    ${HAL_DIR}/include
+# Include directories for application module:
+set(APPLICATION_INCLUDE_DIRS
     ${SRC_PATH}/application/tensorflow-lite-micro/include
     ${SRC_PATH}/application/main/include
-    ${PLAT_INCLUDE_DIRS}
-    ${PROFILER_DIR}/include
-    )
+    ${PROFILER_DIR}/include)
 
+# Source files for application module:
 file(GLOB_RECURSE SRC_APPLICATION
     "${SRC_PATH}/application/main/*.cc"
     "${SRC_PATH}/application/main/*.cpp"
@@ -191,15 +122,22 @@ file(GLOB_RECURSE SRC_APPLICATION
     "${SRC_PATH}/application/main/**/*.cc"
     "${SRC_PATH}/application/main/**/*.cpp"
     "${SRC_PATH}/application/main/**/*.c"
+    "${SRC_PATH}/application/tensorflow-lite-micro/**/*.cc"
+    "${SRC_PATH}/application/tensorflow-lite-micro/*.cc"
     "${PROFILER_DIR}/*.cc"
     "${PROFILER_DIR}/*.cpp"
     "${PROFILER_DIR}/*.c"
     )
 list(FILTER SRC_APPLICATION EXCLUDE REGEX ".*main\\.c.*$")
+set(SRC_MAIN "${SRC_PATH}/application/main/Main.cc")
+set_source_files_properties(${SRC_MAIN}
+    PROPERTIES COMPILE_DEFINITIONS
+    "PRJ_VER_STR=\"${PROJECT_VERSION}\";PRJ_DES_STR=\"${PROJECT_DESCRIPTION}\"")
 
 list(JOIN USE_CASE_BUILD "" USE_CASE_BUILD_STR)
 list(APPEND USE_CASES_SEARCH_DIR_LIST ${SRC_PATH}/use_case)
 message(STATUS "Use-cases source paths: ${USE_CASES_SEARCH_DIR_LIST}.")
+
 if (${USE_CASE_BUILD_STR} STREQUAL all)
     foreach(USE_CASES_SEARCH_DIR ${USE_CASES_SEARCH_DIR_LIST})
         SUBDIRLIST(USE_CASES_SUBDIRS ${USE_CASES_SEARCH_DIR})
@@ -209,30 +147,6 @@ else()
     set(USE_CASES ${USE_CASE_BUILD})
 endif()
 
-if (NOT ${CMAKE_CROSSCOMPILING})
-
-    #Test TPIP
-    set(TEST_TPIP ${DOWNLOAD_DEP_DIR}/test)
-    file(MAKE_DIRECTORY ${TEST_TPIP})
-    set(TEST_TPIP_INCLUDE ${TEST_TPIP}/include)
-    file(MAKE_DIRECTORY ${TEST_TPIP_INCLUDE})
-
-    include(ExternalProject)
-
-    ExternalProject_Add(catch2-headers
-        URL https://github.com/catchorg/Catch2/releases/download/v2.11.1/catch.hpp
-        DOWNLOAD_NO_EXTRACT 1
-        CONFIGURE_COMMAND ""
-        BUILD_COMMAND bash -c "cp -R <DOWNLOAD_DIR>/catch.hpp ${TEST_TPIP_INCLUDE}"
-        INSTALL_COMMAND ""
-        )
-endif ()
-
-list(APPEND APPLICATION_LIBS
-        ${TENSORFLOW_LIBRARY}
-        $<$<BOOL:${ETHOS_U_NPU_ENABLED}>:${ETHOS_U_NPU_LIBS}>
-        $<$<BOOL:${CMSIS_DSP_LIB}>:${CMSIS_DSP_LIB}>)
-
 message(STATUS "Building use-cases: ${USE_CASES}.")
 foreach(use_case ${USE_CASES})
 
@@ -252,8 +166,8 @@ foreach(use_case ${USE_CASES})
     # Executable application:
     set(TARGET_NAME "ethos-u-${use_case}")
 
-    set(DEFAULT_MODEL_DIR       ${RESOURCES_DIR}/${use_case})
-    set(DEFAULT_TEST_DATA_DIR   ${DEFAULT_MODEL_DIR})
+    set(DEFAULT_MODEL_DIR ${RESOURCES_DIR}/${use_case})
+    set(DEFAULT_TEST_DATA_DIR ${DEFAULT_MODEL_DIR})
     set(SRC_GEN_DIR ${CMAKE_BINARY_DIR}/generated/${use_case}/src)
     set(INC_GEN_DIR ${CMAKE_BINARY_DIR}/generated/${use_case}/include)
 
@@ -261,36 +175,25 @@ foreach(use_case ${USE_CASES})
     file(REMOVE_RECURSE ${SRC_GEN_DIR} ${INC_GEN_DIR})
     file(MAKE_DIRECTORY ${SRC_GEN_DIR} ${INC_GEN_DIR})
 
+    file(GLOB UC_CMAKE_FILE
+        "${SRC_USE_CASE}/${use_case}/*.cmake")
+
+    include(${UC_CMAKE_FILE})
+
     file(GLOB_RECURSE UC_SRC
         "${SRC_USE_CASE}/${use_case}/src/*.cpp"
         "${SRC_USE_CASE}/${use_case}/src/*.cc"
         "${SRC_USE_CASE}/${use_case}/src/*.c"
         "${SRC_USE_CASE}/${use_case}/src/**/*.cpp"
         "${SRC_USE_CASE}/${use_case}/src/**/*.cc"
-        "${SRC_USE_CASE}/${use_case}/src/**/*.c"
-        )
-
-    set(UC_INCLUDE
-        ${SRC_USE_CASE}/${use_case}/include
-        )
-
-    file(GLOB UC_CMAKE_FILE
-        "${SRC_USE_CASE}/${use_case}/*.cmake"
-        )
-
-    include(${UC_CMAKE_FILE})
+        "${SRC_USE_CASE}/${use_case}/src/**/*.c")
 
     file(GLOB_RECURSE SRC_GEN
         "${SRC_GEN_DIR}/*.cc"
         "${SRC_GEN_DIR}/*.cpp"
-        "${SRC_GEN_DIR}/*.c"
-        )
-
-    set(SRC_MAIN "${SRC_PATH}/application/main/Main.cc")
+        "${SRC_GEN_DIR}/*.c")
 
-    set_source_files_properties(${SRC_MAIN}
-        PROPERTIES COMPILE_DEFINITIONS
-        "PRJ_VER_STR=\"${PROJECT_VERSION}\";PRJ_DES_STR=\"${PROJECT_DESCRIPTION}\"")
+    set(UC_INCLUDE  ${SRC_USE_CASE}/${use_case}/include)
 
     if (DEFINED ${use_case}_COMPILE_DEFS)
         message(STATUS "Additional compilation flags for ${use_case}: ${${use_case}_COMPILE_DEFS}")
@@ -304,140 +207,33 @@ foreach(use_case ${USE_CASES})
     # Consolidated application static lib:
     add_library(${UC_LIB_NAME} STATIC
         ${SRC_APPLICATION}
-        ${SRC_TENSORFLOW_LITE_MICRO}
-        ${SRC_HAL}
         ${UC_SRC}
-        ${SRC_GEN}
-        )
+        ${SRC_GEN})
+
     target_include_directories(${UC_LIB_NAME} PUBLIC
         ${APPLICATION_INCLUDE_DIRS}
-        ${DEP_RUNTIME_INCLUDE_DIRS}
         ${UC_INCLUDE}
         ${INC_GEN_DIR}
-        )
+        ${TENSORFLOW_SRC_PATH}/tensorflow/lite/micro/tools/make/downloads/flatbuffers/include)
 
     # Set the activation buffer size
     target_compile_definitions(${UC_LIB_NAME} PUBLIC
             "ACTIVATION_BUF_SZ=${${use_case}_ACTIVATION_BUF_SZ}")
 
-    add_dependencies(${UC_LIB_NAME} tensorflow-lite-micro)
-
-    if (${CMAKE_CROSSCOMPILING})
-        # If we are building timing adapter, set the dependency:
-        if (ETHOS_U_NPU_ENABLED)
-            message(STATUS "Adding timing_adapter as a dependency to ${UC_LIB_NAME}")
-            add_dependencies(${UC_LIB_NAME} timing_adapter)
-        endif()
-
-        # If building with CMSIS-DSP support:
-        if (DEFINED CMSIS_DSP_TARGET)
-            message(STATUS "Adding ${CMSIS_DSP_TARGET} as a dependency to ${UC_LIB_NAME}")
-            add_dependencies(${UC_LIB_NAME} ${CMSIS_DSP_TARGET})
-        endif()
-    endif()
-
-    target_link_libraries(${UC_LIB_NAME} PUBLIC ${APPLICATION_LIBS})
-
-    add_executable(${TARGET_NAME} ${SRC_MAIN} ${PLAT_RETARGET_SOURCE})
+    target_link_libraries(${UC_LIB_NAME} PUBLIC
+        log
+        arm_math
+        hal
+        tensorflow-lite-micro
+        $<$<BOOL:${APPLICATION_EXTRA_LIBS}>:${APPLICATION_EXTRA_LIBS}>
+        )
 
-    target_link_libraries(${TARGET_NAME} ${UC_LIB_NAME})
+    add_executable(${TARGET_NAME} ${SRC_MAIN})
 
-    if (${CMAKE_CROSSCOMPILING})
-        set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".axf")
-        add_target_map_file(${TARGET_NAME} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${TARGET_NAME}.map)
-    endif()
+    target_link_libraries(${TARGET_NAME} PUBLIC ${UC_LIB_NAME})
 
-    if (${TARGET_PLATFORM} STREQUAL mps3 OR ${TARGET_PLATFORM} STREQUAL simple_platform)
-
-        set(SECTORS_DIR ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sectors)
-        set(SECTORS_BIN_DIR ${SECTORS_DIR}/${use_case})
-
-        file(REMOVE_RECURSE ${SECTORS_BIN_DIR})
-        file(MAKE_DIRECTORY ${SECTORS_BIN_DIR})
-
-        add_bin_generation_command(
-            TARGET_NAME ${TARGET_NAME}
-            OUTPUT_DIR  ${SECTORS_BIN_DIR}
-            AXF_PATH    ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${TARGET_NAME}.axf
-            SECTION_PATTERNS    "${LINKER_SECTION_TAGS}"
-            OUTPUT_BIN_NAMES    "${LINKER_OUTPUT_BIN_TAGS}")
-
-        if (${TARGET_PLATFORM} STREQUAL mps3)
-            file(COPY ${MPS3_FPGA_CONFIG} DESTINATION ${SECTORS_DIR})
-        endif()
-
-    elseif (${TARGET_PLATFORM} STREQUAL native)
-
-        # If native build tests
-        set(TEST_SRC_USE_CASE "")
-        foreach(USE_CASES_TESTS_SEARCH_DIR ${USE_CASES_TESTS_SEARCH_DIR_LIST})
-
-            if (EXISTS ${USE_CASES_TESTS_SEARCH_DIR}/${use_case})
-                message(STATUS "Found tests for use-case ${use_case} at ${USE_CASES_TESTS_SEARCH_DIR}/${use_case}.")
-                set(TEST_SRC_USE_CASE ${USE_CASES_TESTS_SEARCH_DIR})
-                break()
-            endif ()
-        endforeach()
-
-        # Add tests only if they exists for the usecase
-        if (NOT ${TEST_SRC_USE_CASE} STREQUAL "")
-
-            set(TEST_RESOURCES_INCLUDE
-                "${TEST_SRCS}/utils/"
-                "${TEST_SRC_USE_CASE}/${use_case}/include/"
-                )
-
-            # Define Test sources and new target to run unit tests
-            file(GLOB_RECURSE TEST_SOURCES
-                "${TEST_SRCS}/common/*.cpp"
-                "${TEST_SRCS}/common/*.cc"
-                "${TEST_SRCS}/utils/*.cc"
-                "${TEST_SRCS}/utils/*.cpp"
-                "${TEST_SRC_USE_CASE}/${use_case}/*.cpp"
-                "${TEST_SRC_USE_CASE}/${use_case}/*.cc"
-                "${TEST_SRC_USE_CASE}/${use_case}/*.c"
-                "${TEST_SRC_USE_CASE}/${use_case}/**/*.cpp"
-                "${TEST_SRC_USE_CASE}/${use_case}/**/*.cc"
-                "${TEST_SRC_USE_CASE}/${use_case}/**/*.c"
-                )
-
-            set(TEST_SRC_GEN_DIR ${CMAKE_BINARY_DIR}/generated/${use_case}/tests/src)
-            set(TEST_INC_GEN_DIR ${CMAKE_BINARY_DIR}/generated/${use_case}/tests/include)
-            file(MAKE_DIRECTORY ${TEST_SRC_GEN_DIR} ${TEST_INC_GEN_DIR})
-
-            set(${use_case}_DEFAULT_TEST_DATA_DIR ${DEFAULT_TEST_DATA_DIR} CACHE PATH "")
-            # Generate test data files to be included in x86 tests
-            generate_test_data_code(
-                    INPUT_DIR "${${use_case}_DEFAULT_TEST_DATA_DIR}"
-                    DESTINATION_SRC ${TEST_SRC_GEN_DIR}
-                    DESTINATION_HDR ${TEST_INC_GEN_DIR}
-                    NAMESPACE "test"
-            )
-
-            file(GLOB_RECURSE TEST_SOURCES_GEN
-                "${TEST_SRC_GEN_DIR}/*.cc"
-                "${TEST_SRC_GEN_DIR}/**/*.cc"
-                )
-            message(STATUS "Adding ${TEST_SOURCES_GEN} to test sources")
-            list(APPEND TEST_SOURCES ${TEST_SOURCES_GEN})
-            list(APPEND TEST_RESOURCES_INCLUDE ${TEST_INC_GEN_DIR})
-
-            set(TEST_TARGET_NAME "${CMAKE_PROJECT_NAME}-${use_case}-tests")
-            add_executable(${TEST_TARGET_NAME} ${TEST_SOURCES})
-            target_include_directories(${TEST_TARGET_NAME} PUBLIC
-                ${TEST_TPIP_INCLUDE} ${TEST_RESOURCES_INCLUDE})
-            target_link_libraries(${TEST_TARGET_NAME} ${UC_LIB_NAME})
-            target_compile_definitions(${TEST_TARGET_NAME} PRIVATE
-                "ACTIVATION_BUF_SZ=${${use_case}_ACTIVATION_BUF_SZ}"
-                TESTS)
-
-            add_dependencies(
-                "${TEST_TARGET_NAME}"
-                "catch2-headers"
-            )
+    platform_custom_post_build(TARGET_NAME ${TARGET_NAME})
 
-        endif ()
-    endif ()
 endforeach()
 
-print_useroptions()
+print_useroptions()
\ No newline at end of file