Merge pull request #115 from forGGe/release

0.2.0 release

Author: forGGe

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "kernel/freertos/freertos"]
 	path = kernel/freertos/freertos
 	url = https://github.com/cjlano/freertos.git
+[submodule "lib/cmsis/CMSIS"]
+	path = lib/cmsis/CMSIS
+	url = https://github.com/ARM-software/CMSIS.git
+[submodule "lib/stm32-spl/SPL"]
+	path = lib/stm32-spl/SPL
+	url = https://github.com/forGGe/spl-hub.git

.travis.yml

@@ -5,10 +5,12 @@ branches:
     only:
         - develop
         - master
+        - release
 
 install:
-    - curl https://nixos.org/nix/install | sh
+    - travis_retry curl https://nixos.org/nix/install -o nix_install.sh
+    - sh nix_install.sh
     - . $HOME/.nix-profile/etc/profile.d/nix.sh
-    - nix-shell --pure --run true
+    - travis_retry nix-shell --pure --run true
 
 script: nix-shell --pure --run ./scripts/ci_test.sh

CMakeLists.txt

@@ -19,26 +19,26 @@ include(CppcheckTargets)
 # TODO: add same configuration mechanism for choosing right kernel
 message(STATUS "Checking [CONFIG_PLATFORM]...")
 if(NOT DEFINED CONFIG_PLATFORM)
-	message(STATUS "CONFIG_PLATFORM is not set, defaulting to 'host'...")
-	set(PLATFORM_NAME host)
+    message(STATUS "CONFIG_PLATFORM is not set, defaulting to 'host'...")
+    set(PLATFORM_NAME host)
 else()
-	message(STATUS "Platform will be used: ${CONFIG_PLATFORM}")
-	set(PLATFORM_NAME ${CONFIG_PLATFORM}) # For convinience
+    message(STATUS "Platform will be used: ${CONFIG_PLATFORM}")
+    set(PLATFORM_NAME ${CONFIG_PLATFORM}) # For convinience
 endif()
 
 # Set general flags for C\C++ compiler and linker
 set(CC_WARN_FLAGS "-Wall -Wextra -Wpedantic -Werror")
 set(CXX_WARN_FLAGS "${CC_WARN_FLAGS} -Weffc++")
 
 set(CMAKE_C_FLAGS
-"${CMAKE_C_FLAGS} ${CC_WARN_FLAGS} ${CC_EXTRA_FLAGS}")
+        "${CMAKE_C_FLAGS} ${CC_WARN_FLAGS} ${CC_EXTRA_FLAGS}")
 set(CMAKE_CXX_FLAGS
-"${CMAKE_CXX_FLAGS} ${CC_WARN_FLAGS} ${CXX_EXTRA_FLAGS}")
+        "${CMAKE_CXX_FLAGS} ${CC_WARN_FLAGS} ${CXX_EXTRA_FLAGS}")
 
 # Linker definitions is propagated by the platform.
 include(${CORE_DIR}/platform/common/linker.cmake)
 
-# The top-level library target, essesnce of this project.
+# The top-level library target, essence of this project.
 add_library(${PROJECT_NAME} INTERFACE)
 target_link_libraries(${PROJECT_NAME} INTERFACE startup)
 target_link_libraries(${PROJECT_NAME} INTERFACE ${PLATFORM_NAME})
@@ -47,26 +47,9 @@ target_link_libraries(${PROJECT_NAME} INTERFACE ${PLATFORM_NAME})
 # that platform will be added in first place
 add_subdirectory(platform)
 
-# Stripping is requested
-if (${CONFIG_EXEC_STRIP})
-	# Create new name
-	get_filename_component(EXEC_NAME ${EXEC_PATH} NAME)
-
-	# Make binary from the project object file
-	add_custom_target(${EXEC_NAME}_bin ALL
-		COMMAND ${CMAKE_OBJCOPY} --output-format=binary
-		${EXEC_PATH} ${EXEC_PATH}.bin
-		DEPENDS ${EXEC_PATH}
-		COMMENT "Making binary from ${EXEC_PATH} ..."
-	)
-
-	# Clean binary on 'make clean' call
-	set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${EXEC_PATH}.bin)
-endif()
-
 # Required layer only when cross-compiling
-if (CMAKE_CROSSCOMPILING)
-	add_subdirectory(sys)
+if(CMAKE_CROSSCOMPILING)
+    add_subdirectory(sys)
 endif()
 
 # Rest of modules

README.md

@@ -5,8 +5,10 @@
 
 ## Description
 
-The Core is highly configurable, straightforward C++ framework with minimum set of development dependencies. It aimed to reduce development efforts for embedded applications.
-The main idea of The Core is to make as much as possible in the compile time. This affects the way how the device drivers and peripherals are represented. In fact, each driver is the template class that is instantiated with all the dependencies in a distinct type by user of The Core in compile-time.
+The Core is highly configurable and straightforward C++ framework aimed to reduce development efforts for embedded applications.
+The main idea of The Core is to make as much as possible in the compile time.
+This affects the way how the device drivers and peripherals are represented.
+In fact, each driver is the template class that is instantiated with all the dependencies in a distinct type by user of The Core in the compile time.
 
 You can check out more directly in the code of [the SPI driver](platform/stm32f4xx/export/platform/spi_bus.hpp) or  [the USART bus](platform/stm32f4xx/export/platform/usart_bus.hpp).
 
@@ -22,8 +24,9 @@ The project is at the initial stage. But something is already in there:
 
 ## Getting started
 
-If you are interested in the simplest, ready-made demo project based on The Core,
-refer to [the blinky example project](https://github.com/forGGe/theCore-blinky).
+If you are interested in the simplest, ready-made demo project based on The Core, refer to [the blinky example project](https://github.com/forGGe/theCore-blinky).
+
+You may also check [examples within theCore source tree](examples/).
 
 In order to proceed with The Core itself, start cloning this repository:
 ```
@@ -33,10 +36,7 @@ git clone https://github.com/forGGe/theCore.git
 When the code is received, you have to download and install all the dependencies.
 The process can take some time.
 To make it easier, I’d strongly recommend to download and install `nix`.
-The installation guide could be found
-[on the official website](https://nixos.org/nixos/manual/index.html#ch-installation) or
-[Domenkozar's blog](https://www.domenkozar.com/2014/01/02/getting-started-with-nix-package-manager/)
-.
+The installation guide can be found [on the official website](https://nixos.org/nixos/manual/index.html#ch-installation) or [Domenkozar's blog](https://www.domenkozar.com/2014/01/02/getting-started-with-nix-package-manager/).
 
 After `nix` installation, run:
 ```bash
@@ -69,13 +69,14 @@ Currently, the stm32f4xx platform is supported and available for further develop
 
 ## Documentation
 
-The current documentation of The Core is completely stated in the code (as doxygen comments). To generate the HTML pages from Doxygen is quite enough to run:
+The current documentation of The Core is completely stated in the code (as doxygen comments).
+To generate the HTML pages from Doxygen is quite enough to run:
 
 ```bash
 make core_doc
 ```
 
-in the build directory (see [units](#unit-tests)).
+in the build directory (see [unit tests section](#unit-tests)).
 
 ## License
 
@@ -84,6 +85,10 @@ The source code is distributed under LGPL v3.0 License.
 
 ## Contribution & Using
 
-The project is on its very beginning, so any help is more than welcome and highly appreciated. If you'd like to take a part in the project growth and (or) have any questions – feel free to email me at [email protected], leave message at [gitter](https://gitter.im/forGGe/theCore) or simply check out [a list of issues](https://github.com/forGGe/theCore/issues). If you have any suggestions on The Core improvement or just like it how it is, don’t keep silence! I’ll be happy to read your reviews.
+The project is on its very beginning, so any help is more than welcome and highly appreciated.
+If you'd like to take a part in the project growth and (or) have any questions – feel free to email me at [email protected], leave message at [gitter](https://gitter.im/forGGe/theCore) or simply check out [a list of issues](https://github.com/forGGe/theCore/issues).
+If you have any suggestions on The Core improvement or just like it how it is, don’t keep silence! I’ll be happy to read your reviews.
 
-You are welcome to use The Core in your own projects. If there is something that it’s not enough for this, please let me know via email or open some issues and we will do our best to handle this ASAP. Good luck!
+You are welcome to use The Core in your own projects.
+If there is something that it’s not enough for this, please let me know via email or open some issues and we will do our best to handle this ASAP.
+Good luck!

build_api.cmake

@@ -1,9 +1,8 @@
-if (__build_api_def)
+if(__build_api_def)
     return()
-endif ()
+endif()
 set(__build_api_def YES)
 
-
 # Might be reviewed
 cmake_minimum_required(VERSION 3.2)
 
@@ -16,13 +15,13 @@ include(CMakeParseArguments)
 # Add modules dir to search path
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/modules)
 
-# Registers a project
-macro(register_project project_name path_to_exe_file)
-	set(EXEC_PATH ${path_to_exe_file})
-
-    # Make sure the core is included
-	add_subdirectory(${CORE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/core)
-endmacro()
+# Add test only if not cross-compiling
+if(${CMAKE_HOST_SYSTEM_NAME} STREQUAL ${CMAKE_SYSTEM_NAME})
+    find_package(CppUTest)
+    if(NOT ${CPPUTEST_FOUND})
+        message(WARNING "CppUTest library not present. Tests are disabled.")
+    endif()
+endif()
 
 # Creates a host unit test with name unit_test_${test_name}
 # TODO: move this to separate module
@@ -33,50 +32,69 @@ endmacro()
 #					 [DEPENDS list_of_dependencies...]
 #					 [INC_DIRS list_of_include_directories...])
 function(add_unit_host_test)
-	# All test can use most recent standart
-	set(CMAKE_CXX_STANDARD 14)
-
-	# Add test only if not cross-compiling
-	if (${CMAKE_HOST_SYSTEM_NAME} STREQUAL ${CMAKE_SYSTEM_NAME})
-
-		find_package(CppUTest REQUIRED)
-
-		cmake_parse_arguments(
-			UNIT_TEST
-			"OPTIONAL"
-			"NAME"
-			"SOURCES;DEPENDS;INC_DIRS"
-			${ARGN}
-			)
-
-		if(DEFINED UNIT_TEST_NAME AND DEFINED UNIT_TEST_SOURCES)
-			set(UNIT_TEST_NAME unit_test_${UNIT_TEST_NAME})
-			message("-----------------------------------------------")
-			message("	Test added: ${UNIT_TEST_NAME}")
-			message("	Test sources: ${UNIT_TEST_SOURCES}")
-
-			add_executable(${UNIT_TEST_NAME} ${UNIT_TEST_SOURCES})
-			add_test(NAME ${UNIT_TEST_NAME} COMMAND ${UNIT_TEST_NAME})
-			target_link_libraries(${UNIT_TEST_NAME} CppUTest)
-			target_link_libraries(${UNIT_TEST_NAME} CppUTestExt)
-		else()
-			message(FATAL_ERROR "Test sources and name must be defined!")
-		endif()
-
-		if(UNIT_TEST_DEPENDS)
-			message("	Test dependencies: ${UNIT_TEST_DEPENDS}")
-			target_link_libraries(${UNIT_TEST_NAME} ${UNIT_TEST_DEPENDS})
-		endif()
-
-		if(UNIT_TEST_INC_DIRS)
-			message("	Test includes: ${UNIT_TEST_INC_DIRS}")
-			target_include_directories(
-				${UNIT_TEST_NAME}
-				PRIVATE
-				${UNIT_TEST_INC_DIRS})
-		endif()
+    # All test can use most recent standart
+    set(CMAKE_CXX_STANDARD 14)
+
+    # Protect from missing test utilities
+    if(${CPPUTEST_FOUND})
+        cmake_parse_arguments(
+                UNIT_TEST
+                ""
+                "NAME"
+                "SOURCES;DEPENDS;INC_DIRS"
+                ${ARGN}
+        )
+
+        if(DEFINED UNIT_TEST_NAME AND DEFINED UNIT_TEST_SOURCES)
+            set(UNIT_TEST_NAME unit_test_${UNIT_TEST_NAME})
+            message("-----------------------------------------------")
+            message("	Test added: ${UNIT_TEST_NAME}")
+            message("	Test sources: ${UNIT_TEST_SOURCES}")
+
+            add_executable(${UNIT_TEST_NAME} ${UNIT_TEST_SOURCES})
+            add_test(NAME ${UNIT_TEST_NAME} COMMAND ${UNIT_TEST_NAME})
+            target_link_libraries(${UNIT_TEST_NAME} CppUTest)
+            target_link_libraries(${UNIT_TEST_NAME} CppUTestExt)
+        else()
+            message(FATAL_ERROR "Test sources and name must be defined!")
+        endif()
+
+        if(UNIT_TEST_DEPENDS)
+            message("	Test dependencies: ${UNIT_TEST_DEPENDS}")
+            target_link_libraries(${UNIT_TEST_NAME} ${UNIT_TEST_DEPENDS})
+        endif()
+
+        if(UNIT_TEST_INC_DIRS)
+            message("	Test includes: ${UNIT_TEST_INC_DIRS}")
+            target_include_directories(
+                    ${UNIT_TEST_NAME}
+                    PRIVATE
+                    ${UNIT_TEST_INC_DIRS})
+        endif()
+
+        target_include_directories(${UNIT_TEST_NAME} PRIVATE ${CPPUTEST_INCLUDE_DIRS})
+        message("-----------------------------------------------")
+    endif()
+endfunction()
 
-		target_include_directories(${UNIT_TEST_NAME} PRIVATE ${CPPUTEST_INCLUDE_DIRS})
-		message("-----------------------------------------------")
-	endif()
+# Strips executable, effectively making binary file from it.
+# Use it, if binary is convinient form to deploy code into the board.
+#
+# Syntax:
+# strip_executable(exe_name)
+#   exec_name - name of the target, that was previously added via
+#   add_executable call
+function(strip_executable exec_name)
+    # Make binary from the project object file
+    add_custom_target(${exec_name}_bin ALL
+            COMMAND ${CMAKE_OBJCOPY} --output-format=binary
+            $<TARGET_FILE:${exec_name}>
+            $<TARGET_FILE:${exec_name}>.bin
+            DEPENDS ${exec_name}
+            COMMENT "Making binary from ${exec_name} ..."
+            )
+
+    # Clean binary on 'make clean' call
+    set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES
+            $<TARGET_FILE:${exec_name}>.bin)
 endfunction()

default.nix

@@ -2,19 +2,11 @@
 { pkgs ? import <nixpkgs> {}
 }:
 let
-  gcc-arm-embedded = pkgs.callPackage_i686 ./nix/gcc-arm-embedded {
-    dirName = "5.0";
-    subdirName = "5-2015-q4-major";
-    version = "5.2-2015q4-20151219";
-    releaseType = "major";
-    sha256 = "12mbwl9iwbw7h6gwwkvyvfmrsz7vgjz27jh2cz9z006ihzigi50y";
-  };
-
   cpputest = pkgs.callPackage ./nix/cpputest {};
 
 in with pkgs; {
   coreEnv = stdenv.mkDerivation {
     name = "thecore";
-    buildInputs = [ cmake gcc5 cppcheck cpputest gcc-arm-embedded doxygen ];
+    buildInputs = [ cmake gcc6 cppcheck cpputest gcc-arm-embedded-5_2 doxygen ];
   };
 }

dev/CMakeLists.txt

@@ -1,3 +1,5 @@
 add_subdirectory(pcd8544)
 add_subdirectory(sdspi)
 add_subdirectory(bus)
+add_subdirectory(sensor)
+add_subdirectory(cs43l22)

dev/bus/CMakeLists.txt

@@ -1,9 +1,10 @@
 add_library(bus INTERFACE)
 target_include_directories(bus INTERFACE export)
-target_link_libraries(bus INTERFACE utils)
-target_link_libraries(bus INTERFACE common_bus)
+target_link_libraries(bus INTERFACE dbg)
+target_link_libraries(bus INTERFACE platform_common)
+target_link_libraries(bus INTERFACE thread)
 
 add_unit_host_test(NAME bus
 				   SOURCES tests/bus_unit.cpp
-				   DEPENDS thread_common common_bus
+				   DEPENDS thread_common platform_common dbg
 				   INC_DIRS export tests/mocks)