source: branches/reconfiguration/platforms/tsar_generic_iob/README @ 1064

Last change on this file since 1064 was 1028, checked in by cfuguet, 7 years ago

Fixing indentation in the README file

File size: 3.9 KB
Line 
1Author: Cesar FUGUET TORTOLERO
2
3Platform tsar_generic_iob with fault tolerance
4==============================================
5
6Prerequisites:
7==============
8
91. Checkout the distributed bootloader in another directory (e.g. user home
10directory)
11
12    svn co https://www-soc.lip6.fr/svn/tsar_dist_boot/
13
14
152. In order to execute the distributed bootloader on this platform, you need to
16create first a symbolic link called "soft" to the distributed
17bootloader working directory (obtained during the step 1):
18
19    ln -s <path_to_tsar_dist_boot> soft
20
21
223. Then, you have to set the TSARPATH environment variable to the path of the
23tsar repo's working directory
24
25    In bash:
26
27        export TSARPATH=<path_to_tsar>
28
29    In tcsh:
30
31        setenv TSARPATH <path_to_tsar>
32
33The TSARPATH environment variable is used by the soclib.conf file in order to
34add the hardware components with the fault-tolerance add-ons in the soclib-cc
35description paths.
36
37The soclib.conf expects the tsar working directory to have the trunk/
38directory, and the branches/reconfiguration directory. It is in this second
39directory, where there are the hardware components with fault-tolerance. If you
40don't want to have the branches, and the trunk in different working
41directories, you can directly modify the soclib.conf configuration file, and
42add manually the directories.
43
44
45Execution:
46==========
47
48To execute this platform use preferably the "scripts/onerun.py" script.
49This script creates automatically the configuration files needed to compile the
50platform:
51
52  - <outdir>/config/boot_config.h    (contains debug flags)
53  - <outdir>/config/fault_config.h   (contains the coordinates of faulty cores)
54  - <outdir>/config/hard_config.h    (contains hardware parameters' definition)
55
56The name of the <outdir> directory can be passed with the "-o" option of the
57scripts/onerun.py script.
58
59Hereafter a description of the main arguments for the scripts/onerun.py:
60
61  --xsize / -x           # clusters per row
62
63  --ysize / -y           # clusters per column
64
65  --nprocs / -n          # processor cores per cluster
66
67  --compile-only / -c    Do not simulate, only compile both platform and soft
68
69  --batch-mode / -b      Framebuffer and TTYs are not shown.
70                         TTYs are redirected to files
71
72  --faulty-router / -fr  Inject a faulty router. The faulty router is
73                         designated by three arguments: T, X, and Y.
74                         - T is the index of the target NoC
75                           (CMD:0, RSP:1, M2P:2, P2M:3, CLACK:4).
76                         - X and Y are the coordinates of the router.
77                         You can inject several faulty routers by repeating
78                         the -fr parameter.
79                         Example:
80                            Run simulation with a 4x4 mesh, and the routers
81                            CMD(3,3) and RSP(3,0) are faulty.
82
83                                scripts/onerun -x 4 -y 4 -fr 0 3 3 -fr 1 3 0
84
85  --faulty-core / -fc    Inject a faulty core. The faulty core is
86                         designated by three arguments X, Y, and L.
87                         - X, and Y are the global coordinates of the core.
88                         - L is the local id of the core
89                         You can inject several faulty cores by repeating
90                         the -fc parameter.
91                         Example:
92                            Run simulation with a 4x4 mesh, and the
93                            cores (0,0,0) and (2,3,1) are faulty.
94
95                                scripts/onerun -x 4 -y 4 -fc 0 0 0 -fc 2 3 1
96
97  --disk-image / -di     Path to the disk image from which the operating system
98                         will be loaded at the end of the distributed boot
99                         procedure. This disk image is the file handled by the
100                         external disk controller.
101
102
103For more information about the scripts/onerun.py arguments run:
104
105   scripts/onerun.py --help
Note: See TracBrowser for help on using the repository browser.