Skip to content

Commit

Permalink
update readme to reflect latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
wysiwyng committed May 25, 2022
1 parent 5a37c1f commit d5d654d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 14 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,8 @@ and be added flexibly without any hacking in the ETISS source code.

## Getting Started

ETISS has to be built into separate libraries, and a main file is needed
to set up a simulator. After build and installation, the folder `examples/`
will be installed into `<etiss_install_dir>` with correct
configuration. Check `README` in `<etiss_install_dir>/examples/` respectively
to set up a simulator for varied bare-metal simulations.
The ETISS core and included plugins are built as libraries. To make use of the simulator, a program using the library is needed. A very simple bare-metal processor is included in this repository in [src/bare_etiss_processor](src/bare_etiss_processor). This program is built during the normal build process; its compiled binary will be placed under `<build_-_dir>/bin` and `<etiss_install_dir>/bin`. See its [README](src/bare_etiss_processor/README.md) for more details.


### System Requirements

Expand Down Expand Up @@ -77,6 +74,10 @@ Install the package:

$ make install

To save time, compiling can be sped up by using multiple CPU cores:

$ make -j$(nproc)

## WINDOWS SYSTEM

Requirements for Windows:
Expand Down
14 changes: 5 additions & 9 deletions src/bare_etiss_processor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ to simulate. Target software path should be explicitly given for
in this file (e.g. logger severity level).

Check README in `../SW` to assure all prerequisites are fullfilled (e.g.
setting up path to toolchain, getting required libraries, ...). You also
setting up path to toolchain, getting required libraries, ...). You also
find the detailed instructrions to compile SW in respective directories

After checking all prerequisites, execute the following commands to build
Expand All @@ -31,10 +31,6 @@ the example software:

After SW compilation, we can build and run the simulation with the following script:

$ mkdir build && cd build
$ cmake ..
$ make
$ cd ..
$ ./run_helper.sh path/to/target/binary


Expand All @@ -45,13 +41,13 @@ After SW compilation, we can build and run the simulation with the following scr

$ cmake --build . --config $BUILD_TYPE

Set the PATH variable to include files in the build/installed/lib/ folder and then run the program by passing required architecture, jit and plugins. An example is shown here. Please use --help to display all configurations supported.
Set the PATH variable to include files in the build/installed/lib/ folder and then run the program by passing required architecture, jit and plugins. An example is shown here. Please use --help to display all configurations supported.

$ $Env:Path="X:/path/to/lib;"+$Env:Path
$ cd build/$BUILD_TYPE
$ cd build/$BUILD_TYPE

> NOTE: $BUILD_TYPE is either Release or Debug depending on how it was compiled.)
$ main --vp.elf_file=X:/path/to/build/installed/examples/SW/riscv/build/riscv_example --arch.cpu=RISCV --jit.type=TCCJIT --etiss.loglevel=4 -pLogger

## Debugging
Expand Down

0 comments on commit d5d654d

Please sign in to comment.