use the CMake to implement build system

    1. added the CMakeLists.txt for cmake build system
    2. added the config.cmake for cross-compiling
    3. copy the NE10_test.c to ./test/ directory for test sample
    4. updated ReleaseNote

diff --git a/CMakeBuilding.txt b/CMakeBuilding.txt
new file mode 100644 (file)
index 0000000..4484c43
--- /dev/null
+++ b/CMakeBuilding.txt
@@ -0,0 +1,61 @@
+/*
+ *  Copyright 2011-12 ARM Limited
+ *
+ *  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.
+ */
+
+/*
+ * NE10 Library : CMakeBuilding.txt
+ */
+
+=========================BUILDING METHOD=================================
+
+NE10 uses CMake to describe the build in a platform independent manner.
+
+First download and install cmake from cmake.org.
+In Ubuntu, you can install cmake by "sudo apt-get install cmake"
+
+---------------------------NATIVE-COMPILING------------------------------
+For Unix platforms, say the following on a terminal: (Replace $NE10PATH with the directory where this file is located.)
+    cd $NE10PATH
+    mkdir build && cd build
+    cmake ..
+    make
+Then the libNE10.a is placed in ./source/ and a test program "NE10_test_static" is placed in ./test/. you can run it.
+You might want to add -DNE10_BUILD_SHARED=ON to the cmake call to generate the dynamic library and test program "NE10_test_dynamic".
+
+---------------------------CROSS-COMPILING------------------------------
+For cross-compiling, the process is in the following:
+    cd $NE10PATH
+
+Open the config.cmake and change the compiler toolchain to yourself.My toolchain is Linaro GCC 4.6.
+In Ubuntu 11.10 you can install it by "sudo apt-get install gcc-arm-linux-gnueabi".
+    set( CMAKE_C_COMPILER arm-linux-gnueabi-gcc )
+    set( CMAKE_CXX_COMPILER arm-linux-gnueabi-g++ )
+    set( CMAKE_ASM_COMPILER arm-linux-gnueabi-as )
+
+Now you can run cmake to process and generate makefile.
+    mkdir build && cd build
+    cmake -DCMAKE_TOOLCHAIN_FILE=../config.cmake ..
+    make
+
+Then the libNE10.a is placed in ./source/ and a test program "NE10_test_static" is placed in ./test/. you can copy these to the target and run it.
+You might want to add -DNE10_BUILD_SHARED=ON to the cmake call to generate the dynamic library and test program "NE10_test_dynamic".
+
+Note:
+When you run NE10_test_dynamic on the target, you might meet the error:
+    "NE10_test_dynamic: error while loading shared libraries: libNE10_shared.so.10: cannot open shared object file: No such file or directory"
+You can run the following command:
+    export LD_LIBRARY_PATH=$NE10PATH/build/source
+
+--------------------------------END--------------------------------------

diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644 (file)
index 0000000..af6e7f8
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,38 @@
+#
+#  Copyright 2011-12 ARM Limited
+#
+#  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.
+#
+cmake_minimum_required(VERSION 2.6)
+
+project(NE10 C ASM)
+
+option(NE10_BUILD_SHARED "Build NE10 shared libraries" OFF)
+option(NE10_BUILD_STATIC "Build NE10 static libraries" ON)
+option(NE10_BUILD_EXAMPLES "Build NE10 examples" ON)
+
+set(NE10_VERSION 10)
+
+# set complile flags for ARM.
+set( CMAKE_C_FLAGS "-O3 -mthumb-interwork -march=armv7-a -mcpu=cortex-a9 -mfpu=vfp3" )
+
+set( CMAKE_ASM_FLAGS "-mthumb-interwork -march=armv7-a -mcpu=cortex-a9 -mfpu=neon" )
+
+# The NE10 library.
+add_subdirectory(source)
+
+if(NE10_BUILD_EXAMPLES)
+    add_subdirectory(test)
+endif()
+
+

diff --git a/ReleaseNote.txt b/ReleaseNote.txt
index 71ac0f7..7b49535 100644 (file)
--- a/ReleaseNote.txt
+++ b/ReleaseNote.txt
@@ -217,4 +217,4 @@ Details of how to do this are too project specific to detail here.
         Each function is implemented in C, ARM Assembly and NEON code as a
         basis for comparison. Assembly versions, while efficient, are not
         intended as best-practice examples.
-
+    * Added CMake to implement cross-platform build system

diff --git a/config.cmake b/config.cmake
new file mode 100644 (file)
index 0000000..2ec8773
--- /dev/null
+++ b/config.cmake
@@ -0,0 +1,25 @@
+#
+#  Copyright 2011-12 ARM Limited
+#
+#  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.
+#
+set( CMAKE_C_COMPILER arm-linux-gnueabi-gcc )
+set( CMAKE_CXX_COMPILER arm-linux-gnueabi-g++ )
+set( CMAKE_ASM_COMPILER arm-linux-gnueabi-as )
+
+find_program(CMAKE_AR NAMES "arm-linux-gnueabi-ar")
+mark_as_advanced(CMAKE_AR)
+
+find_program(CMAKE_RANLIB NAMES "arm-linux-gnueabi-ranlib")
+mark_as_advanced(CMAKE_RANLIB)
+

diff --git a/source/CMakeLists.txt b/source/CMakeLists.txt
new file mode 100644 (file)
index 0000000..984cf5b
--- /dev/null
+++ b/source/CMakeLists.txt
@@ -0,0 +1,185 @@
+#
+#  Copyright 2011-12 ARM Limited
+#
+#  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.
+#
+
+
+# Define C files.
+set(NE10_C_SRCS
+    NE10_abs.c
+    NE10_addc.c
+    NE10_add.c
+    NE10_divc.c
+    NE10_div.c
+    NE10_len.c
+    NE10_mlac.c
+    NE10_mla.c
+    NE10_mulc.c
+    NE10_mul.c
+    NE10_normalize.c
+    NE10_rsbc.c
+    NE10_setc.c
+    NE10_subc.c
+    NE10_sub.c
+    NE10_dot.c
+    NE10_cross.c
+    NE10_addmat.c
+    NE10_submat.c
+    NE10_mulmat.c
+    NE10_mulcmatvec.c
+    NE10_detmat.c
+    NE10_invmat.c
+    NE10_transmat.c
+    NE10_identitymat.c
+)
+
+# Define intrinsic NEON files.
+set(NE10_INTRINSIC_SRCS
+    NE10_addc.neon.c
+    NE10_divc.neon.c
+    NE10_mlac.neon.c
+    NE10_mulc.neon.c
+    NE10_rsbc.neon.c
+    NE10_setc.neon.c
+    NE10_subc.neon.c
+    NE10_addmat.neon.c
+    NE10_submat.neon.c
+)
+
+# Tell CMake these files need to be compiled with "-mfpu=neon"
+foreach(intrinsic_file ${NE10_INTRINSIC_SRCS})
+    set_source_files_properties(${intrinsic_file} PROPERTIES COMPILE_FLAGS "-mfpu=neon" )
+endforeach(intrinsic_file)
+
+# Define NEON files.
+set(NE10_NEON_SRCS
+    NE10_abs.neon.s
+    NE10_add.neon.s
+    NE10_div.neon.s
+    NE10_len.neon.s
+    NE10_mla.neon.s
+    NE10_mul.neon.s
+    NE10_normalize.neon.s
+    NE10_sub.neon.s
+    NE10_dot.neon.s
+    NE10_cross.neon.s
+    NE10_mulmat.neon.s
+    NE10_mulcmatvec.neon.s
+    NE10_detmat.neon.s
+    NE10_invmat.neon.s
+    NE10_transmat.neon.s
+    NE10_identitymat.neon.s
+    NE10_detmat.neon.inc.s
+)
+
+# Tell CMake these files need to go to the C compiler
+set(FLAGS "-mfpu=neon -Wa,-I../../inc -Wa,-I../../headers -Wa,-I../../ -Wa,-I../../source" )
+foreach(neon_file ${NE10_NEON_SRCS})
+    set_property (SOURCE ${neon_file} PROPERTY LANGUAGE C)
+    set_source_files_properties(
+        ${neon_file} PROPERTIES COMPILE_FLAGS
+        ${FLAGS}
+    )
+endforeach(neon_file)
+
+# Define init files.
+set(NE10_INIT_SRCS
+    ../NE10_init.c
+)
+# Define test files.
+set(NE10_TEST_SRCS
+    NE10_abs_test.c
+    NE10_addc_test.c
+    NE10_add_test.c
+    NE10_divc_test.c
+    NE10_div_test.c
+    NE10_len_test.c
+    NE10_mlac_test.c
+    NE10_mla_test.c
+    NE10_mulc_test.c
+    NE10_mul_test.c
+    NE10_normalize_test.c
+    NE10_rsbc_test.c
+    NE10_setc_test.c
+    NE10_subc_test.c
+    NE10_sub_test.c intrinsic_file
+    NE10_dot_test.c
+    NE10_cross_test.c
+    NE10_addmat_test.c
+    NE10_submat_test.c
+    NE10_mulmat_test.c
+    NE10_mulcmatvec_test.c
+    NE10_detmat_test.c
+    NE10_invmat_test.c
+    NE10_transmat_test.c
+    NE10_identitymat_test.c
+)
+
+include_directories (
+    ../inc
+    ../headers
+    ../
+    ../source
+)
+
+if(NE10_BUILD_STATIC)
+    add_library( NE10 STATIC
+        ${NE10_C_SRCS}
+        ${NE10_INTRINSIC_SRCS}
+        ${NE10_NEON_SRCS}
+        ${NE10_INIT_SRCS}
+    )
+    set_target_properties(NE10 PROPERTIES
+        CLEAN_DIRECT_OUTPUT 1
+        VERSION ${NE10_VERSION}
+    )
+endif()
+
+if(NE10_BUILD_SHARED)
+
+    add_library( NE10_shared SHARED
+        ${NE10_C_SRCS}
+        ${NE10_INTRINSIC_SRCS}
+        ${NE10_NEON_SRCS}
+        ${NE10_INIT_SRCS}
+    )
+
+    set_target_properties(NE10_shared PROPERTIES
+        OUTPUT_NAME "NE10"
+        CLEAN_DIRECT_OUTPUT 1
+        VERSION ${NE10_VERSION}
+    )
+
+    add_library( NE10_test SHARED
+        ${NE10_C_SRCS}
+        ${NE10_INTRINSIC_SRCS}
+        ${NE10_NEON_SRCS}
+        ${NE10_INIT_SRCS}
+    )
+
+    set_target_properties(NE10_test PROPERTIES
+        OUTPUT_NAME "NE10_test"
+        CLEAN_DIRECT_OUTPUT 1
+        VERSION ${NE10_VERSION}
+    )
+
+endif()
+
+# install libraries
+#if(NE10_BUILD_SHARED)
+#    install(TARGETS NE10_shared DESTINATION lib)
+#endif()
+#if(NE10_BUILD_STATIC)
+#    install(TARGETS NE10 DESTINATION lib)
+#endif()

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
new file mode 100644 (file)
index 0000000..7834425
--- /dev/null
+++ b/test/CMakeLists.txt
@@ -0,0 +1,41 @@
+#
+#  Copyright 2011-12 ARM Limited
+#
+#  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.
+#
+
+# header
+include_directories (
+    ../inc
+    ../
+)
+
+if(NE10_BUILD_SHARED)
+    add_executable(NE10_test_dynamic NE10_test.c)
+    target_link_libraries (
+        NE10_test_dynamic
+        NE10_test
+        m
+    )
+endif()
+
+if(NE10_BUILD_STATIC)
+    add_executable(NE10_test_static NE10_test.c)
+    target_link_libraries (
+        NE10_test_static
+        NE10
+        m
+    )
+endif()
+
+

diff --git a/test/NE10_test.c b/test/NE10_test.c
new file mode 100644 (file)
index 0000000..05bb292
--- /dev/null
+++ b/test/NE10_test.c
@@ -0,0 +1,30 @@
+/*
+ *  Copyright 2011-12 ARM Limited
+ *
+ *  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.
+ */
+
+#include "../inc/NE10.h"
+#include "./NE10_init.h"
+
+// This test code shows you how you can statically embed NE10 in your code
+void main()
+{
+   printf ( "Going to initialze NE10...\n" );
+
+   NE10_init();
+
+   printf ( "NE10 has been initialized.\n" );
+
+}
+