Project

General

Profile

MicroTESK Installation Guide » History » Version 19

Andrei Tatarnikov, 07/26/2018 07:14 PM

1 1 Andrei Tatarnikov
h1. MicroTESK for RISC-V Installation Guide
2
3 6 Andrei Tatarnikov
h1. Installation and User Guide
4 1 Andrei Tatarnikov
5
{{toc}}
6
7 8 Andrei Tatarnikov
h2. Installation
8 7 Andrei Tatarnikov
9 1 Andrei Tatarnikov
h3. System Requirements
10
11
MicroTESK is a set of Java-based utilities that are run from the command line. It can be used on *_Windows_*, *_Linux_* and *_OS X_* machines that have *_JDK 1.7 or later_* installed. To be able to recompile the RISC-V ISA specifications, *_Apache Ant version 1.8_ or later* is required.
12
13
h3. Installation Steps
14
15 3 Andrei Tatarnikov
# Download from https://forge.ispras.ru/projects/microtesk-riscv/files and unpack the MicroTESK installation package (the @.tar.gz@ file, latest release) to your computer. The folder to which it was unpacked will be further referred to as the installation directory (@<installation dir>@).
16 1 Andrei Tatarnikov
# Declare the *MICROTESK_HOME* environment variable and set its value to the path to the installation directory (see the *Setting Environment Variables* section).
17
# Set the @<installation dir>/bin@ as the working directory (add the path to the @PATH@ environment variable) to be able to run MicroTESK utilities from any path.
18
19
h3. Setting Environment Variables
20
21
h4. _Windows_
22
23
# Open the @System Properties@ window.
24
# Switch to the @Advanced@ tab.
25
# Click on Environment Variables.
26
# Click @New...@ under @System Variables@.
27
# In the @New System Variable@ dialog specify variable name as @MICROTESK_HOME@ and variable value as @<installation dir>@.
28
# Click @OK@ on all open windows.
29
# Reopen the command prompt window.
30
31
h4. _Linux and OS X_
32
33
Add the command below to the @~.bash_profile@ file (Linux) or the @~/.profile@ file (OS X):
34
<pre>export MICROTESK_HOME=<installation dir></pre> To start editing the file, type @vi ~/.bash_profile@ (or @vi ~/.profile@). Changes will be applied after restarting the command-line terminal or reboot. You can also execute the command in your command-line terminal to make temporary changes.
35
36
h3. Installation Directory Structure
37
38
The MicroTESK installation directory contains the following subdirectories:
39
40
| @arch@   | Examples of microprocessor specifications and test templates for the described designs |
41
| @bin@    | Scripts to run features of MicroTESK (modelling and test generation) |
42
| @doc@    | Documentation on MicroTESK |
43
| @etc@    | MicroTESK configuration files |
44
| @gen@    | Generated Java models of the specified microprocessor designs |
45
| @lib@    | JAR files and Ruby scripts to perform modelling and test generation tasks |
46
| @src@    | Source code of MicroTESK |
47
48 9 Andrei Tatarnikov
h2. Using MicroTESK
49 1 Andrei Tatarnikov
50 14 Andrei Tatarnikov
h3. Compiling ISA specifications
51 10 Andrei Tatarnikov
52 16 Andrei Tatarnikov
_NOTE: Compiling ISA specifications is required only if the user is going to modify them. The distribution package already contains compiled specifications. By default, the ISA specifications are compiled for revision <code>RV64{I,M,F,D,C}</code>._
53 13 Andrei Tatarnikov
54 14 Andrei Tatarnikov
The description of the RISC-V ISA is provided in formal specifications in the nML language. They can be found in the @<installation dir>/arch/riscv/model@ folder. They need to be compiled to be used by MicroTESK.
55 15 Andrei Tatarnikov
To compile them, a user needs to run the Make file stored in the @<installation dir>/arch/riscv/model@ folder:
56 1 Andrei Tatarnikov
57
<pre>
58 14 Andrei Tatarnikov
cd $MICROTESK_HOME/arch/riscv/model
59
make
60 1 Andrei Tatarnikov
</pre>
61
62 17 Andrei Tatarnikov
h3. Generating and compiling test programs
63 12 Andrei Tatarnikov
64 17 Andrei Tatarnikov
Test programs are generated on the basis of test templates. Examples of test templates are provided in the the @<installation dir>/arch/riscv/templates@ folder. Most of them contain comments describing their purpose.
65 1 Andrei Tatarnikov
66 17 Andrei Tatarnikov
To run generation of a test program, a used need to run a Make file located in the same folder. For example:
67 1 Andrei Tatarnikov
68
<pre>
69 18 Andrei Tatarnikov
cd $MICROTESK_HOME/arch/riscv/templates/torture
70 17 Andrei Tatarnikov
make torture
71 1 Andrei Tatarnikov
</pre>
72 19 Andrei Tatarnikov
73
The Make script generates a test program and compiles it with the GNU toolchain. The generated and compiled test program is placed into the @<installation dir>/output/torture/torture@ folder.