The
source filetree is splitted into different directories, each directory being related to a module. Each directory contains two subdirectories include/ and src/, for include and
source files.
This is the part of the project taking care of parsing of the model and collecting/linking informations in the SystemC kernel.
This part of the project use the data collected by the front-end.
This directory contains files used only for testing the project. Usually, each test consists of one file containing a
main() function, and an entry in the file Makefile.tests.
The tests are compiled by running "make test"
This directory is used to store for various kind of scripts usefull for the development, installation or use of the project.
These directories are used by the Makefile to store object files (obj/) and the executable files (bin/). A subdirectory of bin has been created to store executables used only for testing:
bin/tests
Most of the documentation is generated by Doxygen (
http://www.doxygen.org). (You are probably reading a documentation generated in this way.). The configuration file for doxygen is doc/doxygen/DOXYGEN_CONFIG, and some additional files containing no code, but only documentation are in doc/doxygen/ *.doxygen. (In particular, this page has been generated in this way.)
Some figures can be drawn with xfig, and the file must be stored in this directry. The target doc of the Makefile will automatically generate a PNG export in the directory
generate_doc/img/, and can be linked from doxygen documentation.
To be able to compile and use the SystemC front-end, you need to have GCC and SystemC installed, and you also need to apply them the patches located in this directory.
The GCC sources must be installed in a separate directory. The variable GCC_MAIN_HOME_DIR (Or GCC_SSA_HOME_DIR if you are using the SSA branch) must be set in the file Makefile.config.
The file tree pointed by this variable must contain three subdirectories :
This is the
source directory of GCC as you downloaded it from the web.
Directory where GCC will be compiled. You have to create it.
Target directory for the command
make install.
The sources of SystemC must be installed in a separate directory. The variable SYSTEMC_HOME must be set in the file Makefile.config.
Contains various configuration files.
