summaryrefslogtreecommitdiff
path: root/ext/systemc/src/README_TLM.txt
diff options
context:
space:
mode:
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.