README revision 13373 
1This directory holds several examples which show how to build and run systemc
2code and models within gem5. To build a particular example, set the EXTRAS
3variable when running scons so that it gets picked up as part of gem5's build.
4For example:
5
6scons build/ARM/gem5.opt \
7          EXTRAS=util/systemc/systemc_within_gem5/systemc_sc_main
8
9Then when running gem5, you can use the config.py in the corresponding
10directory.
11
12build/ARM/gem5.opt util/systemc/systemc_within_gem5/systemc_sc_main/config.py \
13        --word Hello --word World
14
15
16To rebuild gem5 excluding the example code, be sure to clear the EXTRAS
17variable:
18
19scons build/ARM/gem5.opt EXTRAS=
20
21When building your own models, you don't have to use the EXTRAS mechanism and
22can instead put your source files alongside regular gem5 sources.
23
24
25Existing examples:
26
27systemc_sc_main - Run code based on an sc_main function.
28systemc_simple_object - Build systemc objects into a gem5 object hierarchy.
29
30
31Note that these directories all have a systemc_ prefix so that when EXTRAS
32pastes them into the build directory, they won't conflict with any existing
33top level directory.
34