summaryrefslogtreecommitdiff
path: root/ext/systemc/src/README_TLM.txt
diff options
context:
space:
mode:
authorMatthias Jung <jungma@eit.uni-kl.de>2017-03-01 18:39:56 +0100
committerMatthias Jung <jungma@eit.uni-kl.de>2017-05-18 08:36:56 +0000
commitaa651c7f8321bf96fc88f9a17285225000a753ec (patch)
treeb13240008c970b47bd74a5007e68136155d272fc /ext/systemc/src/README_TLM.txt
parent595e692de09e1b7cbc5f57ac01da299afc066fdd (diff)
downloadgem5-aa651c7f8321bf96fc88f9a17285225000a753ec.tar.xz
ext: Include SystemC 2.3.1 into gem5
In the past it happened several times that some changes in gem5 broke the SystemC coupling. Recently Accelera has changed the licence for SystemC from their own licence to Apache2.0, which is compatible with gem5. However, SystemC usually relies on the Boost library, but I was able to exchange the boost calls by c++11 alternatives. The recent SystemC version is placed into /ext and is integrated into gem5's build system. The goal is to integrate some SystemC tests for the CI in some following patches. Change-Id: I4b66ec806b5e3cffc1d7c85d3735ff4fa5b31fd0 Reviewed-on: https://gem5-review.googlesource.com/2240 Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com> Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>
Diffstat (limited to 'ext/systemc/src/README_TLM.txt')
-rw-r--r--ext/systemc/src/README_TLM.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/ext/systemc/src/README_TLM.txt b/ext/systemc/src/README_TLM.txt
new file mode 100644
index 000000000..f8174e7a0
--- /dev/null
+++ b/ext/systemc/src/README_TLM.txt
@@ -0,0 +1,33 @@
+
+TLM-2.0 standard header files
+=============================
+
+Dir: include/
+
+SubDirs: tlm_core/
+ tlm_1/
+ tlm_2/
+ tlm_utils/
+
+Files: README.txt
+ tlm
+ tlm.h
+
+
+Comments
+========
+
+To use the TLM-2.0 interoperability standard, a user should only include the tlm
+or tlm.h header file. The same holds for the TLM-1.0 implementation that is
+included as part of this kit; only include tlm or tlm.h. These header files
+refer to all the header files within the tlm_core/ subdirectory, everything
+within tlm or tlm.h is contained in the tlm namespace.
+
+The tlm_utils subdirectory contains a set of additional definitions supported
+by the TLM-2.0 standard, but which are not part of the interoperability
+requirements. It contains ease-of-use and convenience implementations for the
+interoperability standard. All objects defined in the tlm_utils directory are
+contained in the tlm_util namespace.
+
+See the README.txt files in the subdirectories for an explanation of the
+internal organization of the header files.