Merge remote-tracking branch 'origin/develop'

Author: eyck

CMakeLists.txt

@@ -11,7 +11,7 @@ option(BUILD_SCC_DOCUMENTATION "Create and install the HTML based API documentat
 option(FULL_TRACE_TYPE_LIST "Test for extended set of templated datatypes" OFF)
 #Note: this needs to match the SystemC kernel build options
 option(SC_WITH_PHASE_CALLBACKS "Whether SystemC is built with simulation phase callbacks" OFF)
-option(SC_WITH_PHASE_CALLBACK_TRACING "whether SystemC was build with pahse callbacks for tracing. It needs to match the SystemC build configuration" OFF)
+option(SC_WITH_PHASE_CALLBACK_TRACING "whether SystemC was build with phase callbacks for tracing. It needs to match the SystemC build configuration" OFF)
 set(SCC_ARCHIVE_DIR_MODIFIER "" CACHE STRING "additional directory levels to store static library archives") 
 set(SCC_LIBRARY_DIR_MODIFIER "" CACHE STRING "additional directory levels to store libraries") 
 
@@ -67,8 +67,11 @@ if(CMAKE_PROJECT_NAME STREQUAL "scc")
     option(ENABLE_CLANG_TIDY "Add clang-tidy automatically to builds" OFF)
     option(BUILD_SCC_LIB_ONLY "Build only the library (no examples" OFF)
     option(INSTALL_DEPENDENCIES "Should dependencies be installed when installing SCC" OFF)
+	set(CLANG_FORMAT_EXCLUDE_PATTERNS "third_party/")
+	find_package(ClangFormat)
 else()
     option(BUILD_SCC_LIB_ONLY "Build only the library (no examples" ON)
+	set(CLANG_FORMAT_EXCLUDE_PATTERNS ${CLANG_FORMAT_EXCLUDE_PATTERNS} "/third_party/" PARENT_SCOPE)
 endif()
 
 if(BUILD_SCC_DOCUMENTATION)
@@ -137,9 +140,6 @@ if(MSVC)
 endif()
 include(SystemCPackage)
 
-set(CLANG_FORMAT_EXCLUDE_PATTERNS "third_party/")
-find_package(ClangFormat)
-
 include(CheckSymbolExists)
 # Check for function getenv()
 check_symbol_exists(getenv "stdlib.h" HAVE_GETENV)
@@ -154,11 +154,11 @@ endif()
 ###############################################################################
 add_subdirectory(src/common)
 if(SystemC_FOUND)
-    add_subdirectory(src/bus_interfaces)
+    add_subdirectory(src/interfaces)
     add_subdirectory(src/components)
     add_subdirectory(src/sysc)
     add_subdirectory(third_party)
-    if(NOT SCC_LIB_ONLY)
+    if(NOT BUILD_SCC_LIB_ONLY)
         if (NOT (DEFINED CMAKE_CXX_CLANG_TIDY OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang"))
             add_subdirectory(examples)
         endif()
@@ -181,7 +181,7 @@ if(SystemC_FOUND)
         target_include_directories(scc INTERFACE ${Boost_INCLUDE_DIRS})
         target_link_libraries(scc INTERFACE ${Boost_datetime_LIBRARY})
     endif()
-    target_link_libraries(scc INTERFACE scc-util scc-sysc components busses scv-tr)
+    target_link_libraries(scc INTERFACE scc-util scc-sysc components interfaces scv-tr)
     target_link_libraries(scc INTERFACE ${FMT_TARGET} spdlog::spdlog)
 
     set_target_properties(scc PROPERTIES
@@ -192,7 +192,7 @@ if(SystemC_FOUND)
 		#set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--export-all-symbols")
 		add_library(scc_shared SHARED $<TARGET_OBJECTS:scc-util>
 	                                  $<TARGET_OBJECTS:scc-sysc>
-	                                  $<TARGET_OBJECTS:busses>
+	                                  $<TARGET_OBJECTS:interfaces>
 	                                  $<TARGET_OBJECTS:scv-tr>
 	                                  )
 	    set_target_properties(scc_shared PROPERTIES CXX_VISIBILITY_PRESET hidden)

README.md

@@ -19,7 +19,7 @@ Here is a short list of features.
 
 * Various optimized trace file implementations   
   * compressed VCD
-  * FST (used by [GTKWave](http://gtkwave.sourceforge.net/))
+  * FST (used by [GTKWave](http://gtkwave.sourceforge.net/) and [Surfer](https://surfer-project.org/))
 
 * Tracing TLM2 Sockets
 
@@ -57,6 +57,11 @@ Here is a short list of features.
 
 The full documentation can be found at the [Github pages](https://minres.github.io/SystemC-Components/)
 
+Build notes
+=======================================
+
+If SystemC is build using cmake with `SC_WITH_PHASE_CALLBACK_TRACING=ON` (which is the default for SystemC 2.3.4), tracing will not work. Either SystemC is being installed with SC_WITH_PHASE_CALLBACK_TRACING=ON (which is the prefered way as this setting is in sync with the automake configure configuration, see https://github.com/accellera-official/systemc/issues/24) or the SCC is being build using `SC_WITH_PHASE_CALLBACK_TRACING=ON`.
+
 Build instructions using conan
 =======================================
 

cmake/SystemCPackage.cmake

@@ -13,6 +13,8 @@ if(NOT SystemC_FOUND)
         find_package(MTISystemC REQUIRED)
         set(SystemC_LIBRARIES SystemC::systemc)
     else()
+    	set(CMAKE_FIND_USE_PACKAGE_REGISTRY FALSE)
+    	set(CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY TRUE)
         find_package(SystemCLanguage QUIET)
         if(TARGET SystemC::systemc) # conan find_package_generator or the cmake of an SystemC installation
             set(SystemC_FOUND true)

contrib/install_wo_conan.cmd

@@ -31,7 +31,7 @@ set GENERATOR=Visual Studio 17 2022
 set TOOLSET=msvc-14.3
 :start_build:
 
-set CMAKE_OPTS=-G "%GENERATOR%" -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_GENERATOR_PLATFORM=x64 -DCMAKE_CXX_STANDARD=%CXX_STD%
+set CMAKE_OPTS=-G "%GENERATOR%" -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_GENERATOR_PLATFORM=x64 -DCMAKE_CXX_STANDARD=%CXX_STD% -DCMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY=ON
 set BOOST_LIB_EXCLUDE=--without-contract --without-fiber --without-graph --without-graph_parallel --without-iostreams --without-json --without-locale --without-log --without-math --without-mpi --without-nowide --without-python --without-random --without-stacktrace --without-test --without-timer --without-wave
 @REM ############################################################################################
 @REM build_boost
@@ -46,7 +46,7 @@ popd
 @REM ############################################################################################
 if NOT EXIST "fmt" tar xzvf fmt_8.0.1.tar.gz
 cmake -S fmt -B build\fmt %CMAKE_OPTS% -DCMAKE_INSTALL_PREFIX=%SCC_HOME% -DBUILD_SHARED_LIBS=ON
-cmake --build build\fmt -j 10 --target install
+cmake --build build\fmt -j 10 --config Release --target install
 @REM ############################################################################################
 @REM build_spdlog
 @REM ############################################################################################
@@ -81,5 +81,5 @@ cmake --build build/systemcams -j 10 --config Release --target install
 @REM build_scc
 @REM ############################################################################################
 if NOT EXIST "scc" tar xzvf scc.tar.gz
-cmake -S scc -B build\scc -Wno-dev %CMAKE_OPTS% -DCMAKE_INSTALL_PREFIX=%SCC_HOME% -DENABLE_CONAN=OFF -DBoost_NO_SYSTEM_PATHS=TRUE -DBOOST_ROOT=%SCC_HOME% -DBOOST_INCLUDEDIR=%SCC_HOME%\include\boost-1_85 -DBoost_NO_WARN_NEW_VERSIONS=ON -DBoost_USE_STATIC_LIBS=ON -DBoost_USE_MULTITHREADED=ON -DBoost_USE_STATIC_RUNTIME=OFF
+cmake -S scc -B build\scc -Wno-dev %CMAKE_OPTS% -DCMAKE_INSTALL_PREFIX=%SCC_HOME% -DENABLE_CONAN=OFF -DBoost_NO_SYSTEM_PATHS=TRUE -DBOOST_ROOT=%SCC_HOME% -DBOOST_INCLUDEDIR=%SCC_HOME%\include\boost-1_85 -DBoost_NO_WARN_NEW_VERSIONS=ON -DBoost_USE_STATIC_LIBS=ON -DBoost_USE_MULTITHREADED=ON -DBoost_USE_STATIC_RUNTIME=OFF -DBUILD_SCC_LIB_ONLY=ON 
 cmake --build build\scc -j 10 --config Release --target install

contrib/install_wo_conan.sh

@@ -89,7 +89,7 @@ function build_lz4 {
     if [ ! -d lz4 ]; then
         if [ ! -f lz4_1.9.4.tar.gz ]; then
             git clone --depth 1 --branch v1.9.4 -c advice.detachedHead=false https://github.com/lz4/lz4.git
-            tar czf lz4_1.9.4.tar.gz yaml-cpp --exclude=.git
+            tar czf lz4_1.9.4.tar.gz lz4 --exclude=.git
         else
             tar xzf lz4_1.9.4.tar.gz
         fi
@@ -145,7 +145,7 @@ function build_scc {
         tar czf scc.tar.gz --exclude=.git scc 
     fi
     cmake -S scc -B build/scc -Wno-dev ${CMAKE_COMMON_SETTINGS} -DCMAKE_INSTALL_PREFIX=${SCC_INSTALL} -DENABLE_CONAN=OFF \
-        -DBoost_NO_SYSTEM_PATHS=TRUE -DBOOST_ROOT=${SCC_INSTALL} -DBoost_NO_WARN_NEW_VERSIONS=ON -DSCC_LIB_ONLY=ON || exit 1
+        -DBoost_NO_SYSTEM_PATHS=TRUE -DBOOST_ROOT=${SCC_INSTALL} -DBoost_NO_WARN_NEW_VERSIONS=ON -DBUILD_SCC_LIB_ONLY=ON || exit 1
     cmake --build build/scc -j 10 --target install || exit 2
 }
 

contrib/pysysc/src/pysysc/scc/__init__.py

@@ -22,10 +22,12 @@ def load_lib(project_dir):
     if os.path.exists(os.path.join(project_dir, 'scc/')):
         logging.debug("Loading SC-Components build dir libs")
         pysysc.add_include_path(os.path.join(project_dir, 'scc/src/common'))
-        pysysc.add_include_path(os.path.join(project_dir, 'scc/third_party'))
+        pysysc.add_include_path(os.path.join(project_dir, "scc/third_party/cci-1.0.0"))
         pysysc.add_include_path(os.path.join(project_dir, 'scc/third_party/scv-tr/src'))
+        pysysc.add_include_path(os.path.join(project_dir, 'scc/third_party/axi_chi'))
         pysysc.add_include_path(os.path.join(project_dir, 'scc/src/sysc'))
         pysysc.add_include_path(os.path.join(project_dir, 'scc/src/components'))
+        pysysc.add_include_path(os.path.join(project_dir, 'scc/src/bus_interfaces'))
     elif os.path.exists(os.path.join(project_dir, 'include/')):
         logging.debug("Loading SC-Components installed libs")
         pysysc.add_include_path(os.path.join(project_dir, 'include'))

examples/ahb_bfm/sc_main.cpp

@@ -1,7 +1,7 @@
-#include <ahb/pin/initiator.h>
-#include <ahb/pin/target.h>
 #include <cci_configuration>
 #include <fstream>
+#include <interfaces/ahb/pin/initiator.h>
+#include <interfaces/ahb/pin/target.h>
 #include <scc/configurable_tracer.h>
 #include <scc/configurer.h>
 #include <scc/report.h>

examples/axi-axi/sc_main.cpp

@@ -6,9 +6,9 @@
  */
 
 #include <array>
-#include <axi/axi_initiator.h>
-#include <axi/axi_target.h>
 #include <axi/scv/recorder_modules.h>
+#include <interfaces/axi/axi_initiator.h>
+#include <interfaces/axi/axi_target.h>
 #include <scc.h>
 #include <scc/configurable_tracer.h>
 #include <scc/hierarchy_dumper.h>
@@ -33,7 +33,7 @@ class testbench : public sc_core::sc_module {
     axi::axi_target<SOCKET_WIDTH> tgt{"tgt"};
 
 private:
-    tlm::scc::initiator_mixin<tlm::tlm_initiator_socket<>> top_isck{"top_isck"};
+    tlm::scc::initiator_mixin<tlm::tlm_initiator_socket<scc::LT>> top_isck{"top_isck"};
     scc::memory<1_GB, 0> mem{"mem"};
 
     unsigned id{0};
@@ -47,7 +47,7 @@ class testbench : public sc_core::sc_module {
     : sc_core::sc_module(nm) {
         SC_THREAD(run);
         intor.clk_i(clk);
-        top_isck(intor.b_tsck);
+        top_isck(intor.tsck);
         tgt.clk_i(clk);
         intor.isck(intor_rec.tsckt);
         intor_rec.isckt(tgt.tsck);

examples/axi4_tlm-pin-tlm/sc_main.cpp

@@ -8,11 +8,11 @@
 #include <array>
 #include <axi/pe/axi_initiator.h>
 #include <axi/pe/simple_target.h>
-#include <axi/pin/axi4_initiator.h>
-#include <axi/pin/axi4_target.h>
 #include <axi/scv/recorder_modules.h>
 #include <csetjmp>
 #include <csignal>
+#include <interfaces/axi/pin/axi4_initiator.h>
+#include <interfaces/axi/pin/axi4_target.h>
 #include <scc.h>
 
 using namespace sc_core;

examples/axi4lite_tlm-pin-tlm/sc_main.cpp

@@ -8,11 +8,11 @@
 #include <array>
 #include <axi/pe/axi_initiator.h>
 #include <axi/pe/simple_target.h>
-#include <axi/pin/axi4_initiator.h>
-#include <axi/pin/axi4_target.h>
 #include <axi/scv/recorder_modules.h>
 #include <csetjmp>
 #include <csignal>
+#include <interfaces/axi/pin/axi4_initiator.h>
+#include <interfaces/axi/pin/axi4_target.h>
 #include <scc.h>
 
 using namespace sc_core;