Merge pull request project-chip#14 from pan-/chip-mbed-integration-at

Sprint 1 demo

.github/workflows/main.yml

@@ -0,0 +1,77 @@
+# Copyright (c) 2020 Project CHIP Authors
+#
+# 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.
+
+name: Build example - Mbed OS
+
+on:
+    push:
+    pull_request:
+
+jobs:
+    mbedos:
+        name: Mbed OS
+
+        env:
+            BUILD_TYPE: mbedos
+
+        runs-on: ubuntu-latest
+
+        container:
+            image: pan2048/chip-build-mbed-os:0.5.0
+            volumes:
+                - "/tmp/output_binaries:/tmp/output_binaries"
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+              # Fetch depth 0 to get all history and be able to check mergepoint for bloat report
+              with:
+                  fetch-depth: 0
+                  submodules: true
+#             - name: Initialize CodeQL
+#               uses: github/codeql-action/init@v1
+#               with:
+#                   languages: "cpp, python"
+#                   queries: +security-and-quality
+            - name: Build example Shell App
+              run: scripts/examples/mbed_example.sh
+            - name: Copy aside build products
+              run: |
+                  mkdir -p example_binaries/$BUILD_TYPE-build
+                  cp examples/shell/mbed/cmake_build/chip-mbed-shell-example.hex \
+                     example_binaries/$BUILD_TYPE-build/chip-mbed-shell-example.hex
+            - name: Binary artifact suffix
+              id: outsuffix
+              uses: haya14busa/action-cond@v1.0.0
+              with:
+                  cond: ${{ github.event.pull_request.number == '' }}
+                  if_true: "${{ github.sha }}"
+                  if_false: "pull-${{ github.event.pull_request.number }}"
+            - name: Copy aside binaries
+              run: |
+                  cp -r example_binaries/$BUILD_TYPE-build /tmp/output_binaries/
+            - name: Uploading Binaries
+              uses: actions/upload-artifact@v1
+              with:
+                  name:
+                      ${{ env.BUILD_TYPE }}-example-build-${{
+                      steps.outsuffix.outputs.value }}
+                  path: /tmp/output_binaries/${{ env.BUILD_TYPE }}-build
+            # - name: Remove third_party binaries for CodeQL Analysis
+            #   run: find . -type d -name "third_party" -exec rm -rf {} +
+            # - name: Remove m5stack-tft binaries for CodeQL Analysis
+            #   run: find . -type d -name "m5stack-tft" -exec rm -rf {} +
+#             - name: Perform CodeQL Analysis
+#               if: ${{ github.event_name == 'push' }}
+#               uses: github/codeql-action/analyze@v1

.vscode/tasks.json

@@ -231,6 +231,20 @@
                     "${workspaceFolder}/examples/pigweed-app/nrfconnect/build"
                 ]
             }
+        },
+        {
+            "label": "Build nRF mbed shell Example",
+            "type": "shell",
+            "command": "scripts/examples/mbed_example.sh",
+            "args": ["-a=shell", "-b=NRF52840_DK", "-p=release"],
+            "group": "build",
+            "problemMatcher": {
+                "base": "$gcc",
+                "fileLocation": [
+                    "relative",
+                    "${workspaceFolder}/examples/shell/mbed/build"
+                ]
+            }
         }
     ]
 }

config/mbed/CMakeLists.txt

@@ -0,0 +1,231 @@
+#
+#   Copyright (c) 2020 Project CHIP Authors
+#
+#   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.
+#
+
+#
+#   @file
+#     CMake sub-project defining 'chip' target which represents CHIP library
+#     and other optional libraries like unit tests, built with 'mbed'
+#     platform.
+#     Since CHIP doesn't provide native CMake support, ExternalProject
+#     module is used to build the required artifacts with GN meta-build
+#     system.
+#
+
+include(ExternalProject)
+
+# ==============================================================================
+# Declare configuration variables and define constants
+# ==============================================================================
+
+# C/C++ compiler flags passed to CHIP build system
+list(APPEND CHIP_CFLAGS)
+
+# C compiler flags passed to CHIP build system
+list(APPEND CHIP_CFLAGS_C)
+
+# C++ compiler flags passed to CHIP build system
+list(APPEND CHIP_CFLAGS_CC)
+
+# CHIP libraries that the application should be linked with
+list(APPEND CHIP_LIBRARIES)
+
+# GN meta-build system arguments in the form of 'key1 = value1\nkey2 = value2...' string
+string(APPEND CHIP_GN_ARGS)
+
+# C/C++ compiler flags which should not be forwarded to CHIP
+# build system (e.g. because CHIP configures them on its own)
+set(CHIP_CFLAG_EXCLUDES 
+    "-fno-asynchronous-unwind-tables"
+    "-fno-common"
+    "-fno-defer-pop"
+    "-fno-reorder-functions"
+    "-ffunction-sections"
+    "-fdata-sections"
+    "-g*"
+    "-O*"
+    "-W*"
+)
+
+# ==============================================================================
+# Helper macros
+# ==============================================================================
+
+macro(chip_gn_arg_string ARG STRING)
+    string(APPEND CHIP_GN_ARGS "${ARG} = \"${STRING}\"\n")
+endmacro()
+
+macro(chip_gn_arg_bool ARG BOOLEAN)
+    if (${BOOLEAN})
+        string(APPEND CHIP_GN_ARGS "${ARG} = true\n")
+    else()
+        string(APPEND CHIP_GN_ARGS "${ARG} = false\n")
+    endif()
+endmacro()
+
+macro(chip_gn_arg_cflags ARG CFLAGS)
+    set(CFLAG_EXCLUDES "[")
+    foreach(cflag ${CHIP_CFLAG_EXCLUDES})
+        string(APPEND CFLAG_EXCLUDES "\"${cflag}\", ")
+    endforeach()
+    string(APPEND CFLAG_EXCLUDES "]")
+    string(APPEND CHIP_GN_ARGS "${ARG} = filter_exclude(string_split(\"${CFLAGS}\"), ${CFLAG_EXCLUDES})\n")
+endmacro()
+
+macro(mbed_interface_library_named name)
+  add_library(${name} INTERFACE)
+  set_property(GLOBAL APPEND PROPERTY ZEPHYR_INTERFACE_LIBS ${name})
+endmacro()
+
+# ==============================================================================
+# Prepare CHIP configuration based on the project configuration
+# ==============================================================================
+
+file(STRINGS ${CMAKE_CURRENT_BINARY_DIR}/config ConfigContents)
+foreach(NameAndValue ${ConfigContents})
+  # Strip leading spaces
+  string(REGEX REPLACE "^[ ]+" "" NameAndValue ${NameAndValue})
+  # Find variable name
+  string(REGEX MATCH "^[^=]+" Name ${NameAndValue})
+  # Find the value
+  string(REPLACE "${Name}=" "" Value ${NameAndValue})
+  # Set the variable
+  set(${Name} "${Value}")
+endforeach()
+
+if (NOT CHIP_ROOT)
+    get_filename_component(CHIP_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
+endif()
+
+# Prepare compiler flags
+
+#convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS CHIP_CFLAGS)
+#convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_C CHIP_CFLAGS_C)
+#convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_CC CHIP_CFLAGS_CC)
+
+# Prepare CHIP libraries that the application should be linked with
+
+if (NOT CHIP_LIBRARIES)
+    set(CHIP_LIBRARIES -lCHIP)
+endif()
+
+if (CONFIG_CHIP_LIB_SHELL)
+    list(APPEND CHIP_LIBRARIES -lCHIPShell)
+endif()
+
+# Set up CHIP project configuration file
+
+if (CONFIG_CHIP_PROJECT_CONFIG)
+    get_filename_component(CHIP_PROJECT_CONFIG 
+        ${CONFIG_CHIP_PROJECT_CONFIG}
+        REALPATH
+        BASE_DIR ${CMAKE_SOURCE_DIR}
+    )
+    set(CHIP_PROJECT_CONFIG "<${CHIP_PROJECT_CONFIG}>")
+else()
+    set(CHIP_PROJECT_CONFIG "")
+endif()
+
+if (${CMAKE_BUILD_TYPE} STREQUAL "debug")
+    set(CONFIG_DEBUG "y")
+endif()
+
+# ==============================================================================
+# Generate configuration for CHIP GN build system
+# ==============================================================================
+
+#chip_gn_arg_cflags("target_cflags"                          ${CHIP_CFLAGS})
+#chip_gn_arg_cflags("target_cflags_c"                        ${CHIP_CFLAGS_C})
+#chip_gn_arg_cflags("target_cflags_cc"                       ${CHIP_CFLAGS_CC})
+chip_gn_arg_string("mbed_ar"                              ${CMAKE_AR})
+chip_gn_arg_string("mbed_cc"                              ${CMAKE_C_COMPILER})
+chip_gn_arg_string("mbed_cxx"                             ${CMAKE_CXX_COMPILER})
+chip_gn_arg_bool  ("is_debug"                               CONFIG_DEBUG)
+chip_gn_arg_bool  ("chip_build_tests"                       CONFIG_CHIP_BUILD_TESTS)
+chip_gn_arg_bool  ("chip_build_libshell"                    CONFIG_CHIP_LIB_SHELL)
+chip_gn_arg_bool  ("chip_with_lwip"                         CONFIG_CHIP_WITH_LWIP)
+
+if (BOARD STREQUAL "native_posix")
+    chip_gn_arg_string("target_cpu" "x86")
+elseif (BOARD STREQUAL "native_posix_64")
+    chip_gn_arg_string("target_cpu" "x64")
+endif()
+
+file(GENERATE OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/args.gn CONTENT ${CHIP_GN_ARGS})
+
+# ==============================================================================
+# Define 'chip-gn' target that builds CHIP library(ies) with GN build system
+# ==============================================================================
+ExternalProject_Add(
+    chip-gn
+    PREFIX                  ${CMAKE_CURRENT_BINARY_DIR}
+    SOURCE_DIR              ${CHIP_ROOT}
+    BINARY_DIR              ${CMAKE_CURRENT_BINARY_DIR}
+    CONFIGURE_COMMAND       gn --root=${CHIP_ROOT}/config/mbed/chip-gn gen --check --fail-on-unused-args ${CMAKE_CURRENT_BINARY_DIR}
+    BUILD_COMMAND           ninja
+    INSTALL_COMMAND         ""
+    BUILD_BYPRODUCTS        ${CHIP_LIBRARIES}
+    BUILD_ALWAYS            TRUE
+    USES_TERMINAL_CONFIGURE TRUE
+    USES_TERMINAL_BUILD     TRUE
+)
+
+# ==============================================================================
+# Define 'chip' target that exposes CHIP headers & libraries to the application
+# ==============================================================================
+mbed_interface_library_named(chip)
+target_compile_definitions(chip INTERFACE CHIP_HAVE_CONFIG_H)
+target_include_directories(chip INTERFACE
+    ${CHIP_ROOT}/src
+    ${CHIP_ROOT}/src/app/server
+    ${CHIP_ROOT}/src/app/util
+    ${CHIP_ROOT}/src/include
+    ${CHIP_ROOT}/src/lib
+    ${CHIP_ROOT}/src/lib/core
+    ${CHIP_ROOT}/third_party/nlassert/repo/include
+    ${CMAKE_CURRENT_BINARY_DIR}/gen/include
+    ${CMAKE_CURRENT_BINARY_DIR}/gen/third_party/connectedhomeip/src/app/include
+)
+target_link_directories(chip INTERFACE ${CMAKE_CURRENT_BINARY_DIR}/lib)
+target_link_libraries(chip INTERFACE -Wl,--start-group ${CHIP_LIBRARIES} -Wl,--end-group)
+add_dependencies(chip chip-gn)
+
+# ==============================================================================
+# Define mbed target configuration according to CHIP component usage
+# ==============================================================================
+# CHIP includes path
+list(APPEND CHIP_INCLUDES)
+
+# CHIP defines
+list(APPEND CHIP_DEFINES)
+
+if (${CONFIG_CHIP_WITH_LWIP})
+    list(APPEND CHIP_INCLUDES 
+        ${CHIP_ROOT}/third_party/lwip/repo/lwip/src/include
+        ${CHIP_ROOT}/src/lwip/mbed
+    )
+    list(APPEND CHIP_DEFINES
+        "LWIP_NO_STDINT_H=1" 
+        "IN_ADDR_T_DEFINED=1"
+    )
+endif()
+
+target_include_directories(${APP_TARGET} PRIVATE 
+                           ${CHIP_INCLUDES}
+)
+
+target_compile_definitions(${APP_TARGET} PRIVATE
+                           ${CHIP_DEFINES}                      
+)

config/mbed/chip-gn/.gn

@@ -0,0 +1,26 @@
+# Copyright (c) 2020 Project CHIP Authors
+#
+# 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.
+
+# The location of the build configuration file.
+buildconfig = "//build/config/BUILDCONFIG.gn"
+
+# CHIP uses angle bracket includes.
+check_system_includes = true
+
+default_args = {
+  target_cpu = "arm"
+  target_os = "mbed"
+
+  import("//args.gni")
+}