Merge pull request COVESA#62 from nayakned/zephyr_support

Zephyr support

Author: nayakned

.devcontainer/Dockerfile

@@ -15,6 +15,6 @@ RUN if [ "${REINSTALL_CMAKE_VERSION_FROM_SOURCE}" != "none" ]; then \
 
 # [Optional] Uncomment this section to install additional packages.
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-     && apt-get -y install --no-install-recommends meson libcmocka0 \
+     && apt-get -y install --no-install-recommends libcmocka0 \
                       libcmocka-dev lcov gcovr gcc-aarch64-linux-gnu \
                       libc6-dev-arm64-cross binutils-aarch64-linux-gnu

.gitignore

@@ -1,5 +1,5 @@
 # Generated directories
-/build
+/build*
 /bin
 /lib
 /release

CMakeLists.txt

@@ -28,7 +28,31 @@
 #
 
 cmake_minimum_required(VERSION 3.20)
+
+# Check first if we are building for Zephyr and include its dependencies accordingly.
+if (DEFINED ENV{ZEPHYR_BASE})
+    if (${OPEN1722_ZEPHYR_APP} STREQUAL "acf-can-bridge")
+        set(KCONFIG_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/examples/acf-can/zephyr/Kconfig)
+    endif()
+    find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+    zephyr_get_include_directories_for_lang_as_string(       C includes)
+    zephyr_get_system_include_directories_for_lang_as_string(C system_includes)
+    zephyr_get_compile_definitions_for_lang_as_string(       C definitions)
+    zephyr_get_compile_options_for_lang_as_string(           C options)
+
+    if(DEFINED CMAKE_C_COMPILER_TARGET)
+        set(target_flag "--target=${CMAKE_C_COMPILER_TARGET}")
+    endif()
+
+  set(external_project_cflags
+    "${target_flag} ${includes} ${definitions} ${options} ${system_includes}"
+    )
+endif()
+
 project(open1722 VERSION 0.1.0 LANGUAGES C DESCRIPTION "Library implementing IEEE 1722")
+
+# Set the compiler options and flags
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_STANDARD_REQUIRED TRUE)
 
@@ -39,56 +63,60 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS "ON")
 add_compile_options(-Wfatal-errors)
 find_program(CCACHE_BIN ccache)
 if(CCACHE_BIN)
-  set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_BIN})
-  set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${CCACHE_BIN})
-  message("Use ccache from ${CCACHE_BIN}")
+    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_BIN})
+    set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${CCACHE_BIN})
+    message("Use ccache from ${CCACHE_BIN}")
 endif()
 
 add_subdirectory(src)
 add_custom_target(examples)
 add_subdirectory(examples EXCLUDE_FROM_ALL)
 
-enable_testing()
-add_custom_target(unittests)
-add_subdirectory(unit EXCLUDE_FROM_ALL)
+# Build tests and install artefacts only for Linux systems
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    enable_testing()
+    add_custom_target(unittests)
+    add_subdirectory(unit EXCLUDE_FROM_ALL)
+
+    install(DIRECTORY include/ DESTINATION include)
+    install(TARGETS open1722 EXPORT Open1722Targets DESTINATION lib)
 
-install(DIRECTORY include/ DESTINATION include)
-install(TARGETS open1722 EXPORT Open1722Targets DESTINATION lib)
+    #### Export Configuration #####################################################
 
-#### Export Configuration #####################################################
+    install(EXPORT Open1722Targets FILE Open1722Targets.cmake DESTINATION lib/cmake/Open1722)
 
-install(EXPORT Open1722Targets FILE Open1722Targets.cmake DESTINATION lib/cmake/Open1722)
+    include(CMakePackageConfigHelpers)
 
-include(CMakePackageConfigHelpers)
+    configure_package_config_file(
+        ${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
+        "${CMAKE_CURRENT_BINARY_DIR}/Open1722Config.cmake"
+        INSTALL_DESTINATION "lib/cmake/Open1722")
 
-configure_package_config_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
-    "${CMAKE_CURRENT_BINARY_DIR}/Open1722Config.cmake"
-    INSTALL_DESTINATION "lib/cmake/Open1722")
+    write_basic_package_version_file(
+        ${CMAKE_CURRENT_BINARY_DIR}/Open1722ConfigVersion.cmake
+        VERSION "${open1722_VERSION_MAJOR}.${open1722_VERSION_MINOR}"
+        COMPATIBILITY AnyNewerVersion)
 
-write_basic_package_version_file(
-    ${CMAKE_CURRENT_BINARY_DIR}/Open1722ConfigVersion.cmake
-    VERSION "${open1722_VERSION_MAJOR}.${open1722_VERSION_MINOR}"
-    COMPATIBILITY AnyNewerVersion)
+    install(FILES
+        ${CMAKE_CURRENT_BINARY_DIR}/Open1722Config.cmake
+        ${CMAKE_CURRENT_BINARY_DIR}/Open1722ConfigVersion.cmake
+        DESTINATION lib/cmake/Open1722)
 
-install(FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/Open1722Config.cmake
-    ${CMAKE_CURRENT_BINARY_DIR}/Open1722ConfigVersion.cmake
-    DESTINATION lib/cmake/Open1722)
+    export(EXPORT Open1722Targets FILE ${CMAKE_CURRENT_BINARY_DIR}/Open1722Targets.cmake)
 
-export(EXPORT Open1722Targets FILE ${CMAKE_CURRENT_BINARY_DIR}/Open1722Targets.cmake)
 
-#### Packaging ################################################################
+    #### Packaging ################################################################
 
-include(InstallRequiredSystemLibraries)
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
-set(CPACK_PACKAGE_VERSION_MAJOR "${open1722_VERSION_MAJOR}")
-set(CPACK_PACKAGE_VERSION_MINOR "${open1722_VERSION_MINOR}")
-set(CPACK_GENERATOR "TGZ" "DEB")
-set(CPACK_SOURCE_GENERATOR "TGZ" "DEB")
+    include(InstallRequiredSystemLibraries)
+    set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
+    set(CPACK_PACKAGE_VERSION_MAJOR "${open1722_VERSION_MAJOR}")
+    set(CPACK_PACKAGE_VERSION_MINOR "${open1722_VERSION_MINOR}")
+    set(CPACK_GENERATOR "TGZ" "DEB")
+    set(CPACK_SOURCE_GENERATOR "TGZ" "DEB")
 
-# Debian package
-set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
-set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Adriaan Niess [Robert Bosch GmbH]")
+    # Debian package
+    set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
+    set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Adriaan Niess [Robert Bosch GmbH]")
 
-include(CPack)
+    include(CPack)
+endif()

README.md

@@ -45,7 +45,7 @@ Open1722 is under BSD License. For more information see LICENSE file.
 
 This repository is organized as follows:
 - The `src/` and `include/` folders contain the IEEE 1722 protocol implementation. We strive to make the implementation platform independant and avoid usage of platform specific headers or libraries. For now the implementation is tested only on Linux.
-- The `examples/` folder contains various applications that use our Open1722 library. The applications are targeted to Linux platforms.
+- The `examples/` folder contains various applications that use our Open1722 library. Most applications are targeted to Linux platforms. Few applications (e.g. [_acf-can-bridge_](./examples/acf-can/zephyr/)) are also ported for Zephyr RTOS. Compilation instructions for Zephyr is available in the corresponding folder of the application.
 
 Before building Open1722 make sure you have installed the following software :
 * CMake >= 3.20
@@ -118,7 +118,7 @@ The `examples/` directory provides sample applications which demonstrate the Ope
 
 To execute the IEEE 1722 CAN Talker application:
 ```
-$ ./build/acf-can-talker
+$ ./build/examples/acf-can/linux/acf-can-talker
 ```
 
 ### Programming Tutorial

examples/CMakeLists.txt

@@ -27,17 +27,26 @@
 # SPDX-License-Identifier: BSD-3-Clause
 #
 
+
 add_library(open1722examples STATIC "common/common.c")
 target_include_directories(open1722examples PRIVATE
-    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>
     $<INSTALL_INTERFACE:include>
     ${CMAKE_CURRENT_SOURCE_DIR})
-
+if (DEFINED ENV{ZEPHYR_BASE})
+    target_link_libraries(open1722examples PRIVATE zephyr_interface)
+endif()
 add_dependencies(examples open1722examples)
 
-add_subdirectory(aaf)
+# These examples can be also built for Zephyr
 add_subdirectory(acf-can)
-add_subdirectory(acf-vss)
-add_subdirectory(crf)
-add_subdirectory(cvf)
-add_subdirectory(hello-world)
+
+# These examples are currently exclusively for Linux
+if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+    add_subdirectory(aaf)
+    add_subdirectory(crf)
+    add_subdirectory(cvf)
+    add_subdirectory(hello-world)
+    add_subdirectory(acf-vss)
+endif()
+
+

examples/acf-can/CMakeLists.txt

@@ -27,22 +27,8 @@
 # SPDX-License-Identifier: BSD-3-Clause
 #
 
-add_executable(acf-can-talker acf-can-talker.c acf-can-common.c)
-target_link_libraries(acf-can-talker open1722 open1722examples)
-target_include_directories(acf-can-talker PUBLIC ${CMAKE_SOURCE_DIR}/include ../)
-
-add_executable(acf-can-listener acf-can-listener.c acf-can-common.c)
-target_link_libraries(acf-can-listener open1722 open1722examples)
-target_include_directories(acf-can-listener PUBLIC ${CMAKE_SOURCE_DIR}/include ../)
-
-add_executable(acf-can-bridge acf-can-bridge.c acf-can-common.c)
-target_link_libraries(acf-can-bridge open1722 open1722examples)
-target_include_directories(acf-can-bridge PUBLIC ${CMAKE_SOURCE_DIR}/include ../)
-
-add_dependencies(examples acf-can-talker acf-can-listener acf-can-bridge)
-
-install(TARGETS
-    acf-can-listener
-    acf-can-talker
-    acf-can-bridge
-    RUNTIME DESTINATION bin)
+if (DEFINED ENV{ZEPHYR_BASE})
+    add_subdirectory(zephyr)
+elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+    add_subdirectory(linux)
+endif()