Skip to content

Commit

Permalink
Update ch04-00-renode-emulation.md
Browse files Browse the repository at this point in the history
quickstart copied from 'xous-core/README.md'
  • Loading branch information
nworbnhoj authored Feb 1, 2024
1 parent 8a093e4 commit a4bb255
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions src/ch04-00-renode-emulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,27 @@
The emulator is available for Windows, Mac, and Linux. It is designed to simulate whole systems of devices, meaning it can easily capture the interactions between devices on a network or bus. It allows you to pause the system and inspect memory, single-step, and watch various sections of the bus.

There is extensive end-user documentation available at [Read the Docs](https://renode.readthedocs.io/en/latest/), which is highly recommended. The remainder of this chapter will cover recommendations on how to use Renode with Xous.

## Quickstart using the Renode emulator

Xous uses [Renode](https://renode.io/) as the preferred emulator, because it is easy to extend the hardware peripherals without recompiling the entire emulator.

[Download Renode](https://renode.io/#downloads) and ensure it is in your path.
For now, you need to [download the nightly build](https://dl.antmicro.com/projects/renode/builds/),
until `DecodedOperation` is included in the release.

Then, build Xous:

```sh
cargo xtask renode-image
```

This will compile everything in `release` mode for RISC-V, compile the tools required to package it all up, then create an image file.

Finally, run Renode and specify the `xous-release.resc` REnode SCript:

```sh
renode emulation/xous-release.resc
```

Renode will start emulation automatically, and will run the same set of programs as in "Hosted mode".

0 comments on commit a4bb255

Please sign in to comment.